SpringBoot集成Swagger-Bootstrap-UI,页面更清爽!(1)

这篇具有很好参考价值的文章主要介绍了SpringBoot集成Swagger-Bootstrap-UI,页面更清爽!(1)。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

springfox-swagger2

2.9.2

com.github.xiaoymin

swagger-bootstrap-ui

1.9.6

二、添加配置类


package com.blog.tutorial.config;

import com.git 需要zi料+ 绿色徽【vip1024b】

hub.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;

import springfox.documentation.builders.PathSelectors;

import springfox.documentation.builders.RequestHandlerSelectors;

import springfox.documentation.service.ApiInfo;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**

* @description:

* @author: youcong

* @time: 2020/11/14 15:46

*/@Configuration

@EnableSwagger2

@EnableSwaggerBootstrapUI

public class SwaggerConfiguration {

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage(“com.blog.tutorial.controller”))

.paths(PathSelectors.any())

.build();

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title(“swagger-bootstrap-ui RESTful APIs”)

.description(“swagger-bootstrap-ui”)

.termsOfServiceUrl(“http://localhost:5050/”)

.contact(“developer@mail.com”)

.version(“1.0”)

.build();

}

}

三、启动项目


启动项目,不报错,然后访问地址:

http://ip:port/doc.html 即可

效果图,如下:

enableswaggerbootstrapui,Java程序员面试,spring boot,bootstrap,ui

测试接口,效果图如下:

enableswaggerbootstrapui,Java程序员面试,spring boot,bootstrap,ui

调式相当于用PostMan测试接口。

四、常用注解


和swagger一样,swagger用的注解,swagger-bootstrap-ui仍能用。

不过结合我的开发经验来看,最常用的也就两个,@Api和@ApiOperation。

@Api的效果,如图:

enableswaggerbootstrapui,Java程序员面试,spring boot,bootstrap,ui

@ApiOperation的效果,如图:

enableswaggerbootstrapui,Java程序员面试,spring boot,bootstrap,ui

由此,我们很容易就看出来,它们的含义是什么,一个是接口分类说明,一个是接口方法说明。

至于这里不用swagger的参数注解,主要原因是不想加太多的注解从而增加代码的数量,造成太多冗余。搜索Java知音公众号,回复“后端面试”,送你一份Java面试题宝典.pdf

例子中的Controller代码:

package com.blog.tutorial.controller;

import com.blog.tutorial.entity.Users;

import com.blog.tutorial.service.UsersService;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiOperation;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**

* @description:

* @author: youcong

* @time: 2020/11/14 13:27

最后

各位读者,由于本篇幅度过长,为了避免影响阅读体验,下面我就大概概括了整理了

enableswaggerbootstrapui,Java程序员面试,spring boot,bootstrap,ui

enableswaggerbootstrapui,Java程序员面试,spring boot,bootstrap,ui

enableswaggerbootstrapui,Java程序员面试,spring boot,bootstrap,ui

enableswaggerbootstrapui,Java程序员面试,spring boot,bootstrap,ui

各位读者,由于本篇幅度过长,为了避免影响阅读体验,下面我就大概概括了整理了

[外链图片转存中…(img-yCwQugic-1710370243449)]

[外链图片转存中…(img-rTKYSuKH-1710370243450)]

[外链图片转存中…(img-wkquf8OB-1710370243451)]

[外链图片转存中…(img-hbNUy3zc-1710370243451)]文章来源地址https://www.toymoban.com/news/detail-859334.html

到了这里,关于SpringBoot集成Swagger-Bootstrap-UI,页面更清爽!(1)的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • swagger 3.0.0 集成 springboot 2.6+ 生成doc.html 和swagger-ui

    1.项目中引入pom.xml依赖 特别说明: doc.html模式 swagger-bootstrap-ui只支持Swagger 2 knife4j是swagger-bootstrap-ui的升级版,支持Swagger 3。 2.创建Swagger2Config配置类 3.启动类输出文档地址 项目运行后 控制台输出log见下图 点击任意文档链接都可以进入对应的文档

    2024年02月12日
    浏览(67)
  • 关于Springboot集成swagger2出现的swagger-resouces和ui请求的404问题

    本项目集成的是增强版的Swagger文档,使用的增强版的UI com.github.xiaoymin 按照上面的配置,在本地测试效果是正常的 在红色标记的地方是正常显示的,但是按照这个配置打war包部署到服务器或者本地的tomcat中就会出现404的现象。 出现上面的这种情况时,看过很多网上的帖子说

    2024年04月17日
    浏览(36)
  • SpringBoot集成Swagger UI显示的接口可以显示Json格式的信息说明

           Swagger是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。        使用 Swagger 后可以直接通过代码生成文档,不再需要自己手动编写接口文档,对程序员来说非常方便,可以节约写文档的时间去学习新技术。        提供 Web 页面在

    2024年04月11日
    浏览(37)
  • SpringBoot集成 Swagger

    1、Swagger 简介 1.1 解决的问题 随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了前后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。前端和后端的唯一联系变成了 API 接口,所以 API 文档变成了前后端开 发人员联系的纽带,变得越

    2024年02月15日
    浏览(40)
  • 【Springboot】集成Swagger

    启动项目后 在浏览器中输入地址 localhost:端口号/swagger-ui/ https://mp.csdn.net/mp_blog/creation/editor/132917702

    2024年02月06日
    浏览(37)
  • Springdoc Swagger UI集成OAuth2认证

    之前的文章讲过OAuth2体系,以 授权码 流程为例(参见下图), 其中资源服务器(Resource Server)作为服务的提供者, 用户在客户端应用完成授权流程后,客户端应用需要 携带AccessToken请求资源服务器 , 也即是要想访问资源服务器就需要提供正确的 Authorization: Bearer AccessToke

    2024年02月02日
    浏览(41)
  • Swagger UI及其集成到Spring Boot应用中

    作者:禅与计算机程序设计艺术 Swagger 是一款开源、功能丰富的 API 概述文档工具。它能够帮助我们快速、清晰地定义、结构化和展示我们的 API,同时也支持多种开发语言,如 Java、JavaScript、Python等。在 Spring Boot 中,使用 Swagger 可以极大方便 API 的测试、调试以及提供给其他

    2024年02月04日
    浏览(37)
  • springboot 集成 Swagger3(速通)

    → springboot 集成 Swagger2 ← 这次直接使用 2.5.6 的 spring-boot 。 依赖: 启动类加注解 @EnableOpenApi 新建测试类 访问 http://127.0.0.1:8080/swagger-ui.html ,没错,又是 Error 页面 此部分参考:https://blog.csdn.net/mmmm0584/article/details/117786055 在swagger3.0中,swagger-ui.html的位置发生了变化:   

    2024年02月03日
    浏览(38)
  • 后端项目开发:集成接口文档(swagger-ui)

    swagger集成文档具有功能丰富、及时更新、整合简单,内嵌于应用的特点。 由于后台管理和前台接口均需要接口文档,所以在工具包构建BaseSwaggerConfig基类。 1.引入依赖 2.需要添加Swagger配置类。 将需要配置的字段提取出来,单独作为一类 前台接口和后台管理的包的配置,只需

    2024年02月11日
    浏览(41)
  • Springboot项目集成Swagger3.0

    开发时经常会出现下面这种情况——“不熟”的接口 因为业务的需要接口文档可能会发生改变,前后端交互上经常会出现参数不符的情况,通过Excel或者Word维护接口文档,会存在时效性较差的问题,而Swagger正是解决这一痛点的利器。在代码中加入注解,可以实时更新接口。

    2024年02月15日
    浏览(45)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包