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 即可
效果圖,如下:
測試接口,效果圖如下:
調式相當于用PostMan測試接口。
四、常用注解
和swagger一樣,swagger用的注解,swagger-bootstrap-ui仍能用。
不過結合我的開發(fā)經驗來看,最常用的也就兩個,@Api和@ApiOperation。
@Api的效果,如圖:
@ApiOperation的效果,如圖:
由此,我們很容易就看出來,它們的含義是什么,一個是接口分類說明,一個是接口方法說明。
至于這里不用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
最后
各位讀者,由于本篇幅度過長,為了避免影響閱讀體驗,下面我就大概概括了整理了
各位讀者,由于本篇幅度過長,為了避免影響閱讀體驗,下面我就大概概括了整理了
[外鏈圖片轉存中…(img-yCwQugic-1710370243449)]
[外鏈圖片轉存中…(img-rTKYSuKH-1710370243450)]
[外鏈圖片轉存中…(img-wkquf8OB-1710370243451)]文章來源:http://www.zghlxwxcb.cn/news/detail-859334.html
[外鏈圖片轉存中…(img-hbNUy3zc-1710370243451)]文章來源地址http://www.zghlxwxcb.cn/news/detail-859334.html
到了這里,關于SpringBoot集成Swagger-Bootstrap-UI,頁面更清爽!(1)的文章就介紹完了。如果您還想了解更多內容,請在右上角搜索TOY模板網以前的文章或繼續(xù)瀏覽下面的相關文章,希望大家以后多多支持TOY模板網!