最新介面api外掛 Swagger3 更新配置詳解
1.引入依賴,版本3.0.0只引入一個即可 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> 2. 配置類SwaggerConfig package org.fh.config; 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.oas.annotations.EnableOpenApi; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; /** * 說明:Swagger 介面API生成 * 作者:FH Admin * from fhadmin.org */ @Configuration @EnableOpenApi public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.OAS_30) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("org.fh.controller")) // 為當前包路徑 .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("FH Admin Swagger3 RESTful API") // 頁面標題 .version("3.0") // 版本號 .description("fhadmin.org") // 描述 .build(); } } 3.Swagger 攔截配置 package org.fh.config; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.ViewControllerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; /** * 說明:Swagger 攔截配置 * 作者:FH Admin * from fhadmin.org */ @Configuration public class WebMvcConfig implements WebMvcConfigurer { @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry. addResourceHandler("/swagger-ui/**") .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/") .resourceChain(false); } @Override public void addViewControllers(ViewControllerRegistry registry) { registry.addViewController("/swagger-ui/") .setViewName("forward:/swagger-ui/index.html"); } } 4.訪問 127.0.0.1:8081/swagger-ui/index.html 5.介面說明案例 處理類上加註解,比如 @Api("使用者註冊登入介面") 在方法上加註解,比如 @ApiOperation(value = "登入", notes="校驗登入是否成功") @ApiImplicitParam(name = "KEYDATA", value = "使用者名稱密碼混淆碼組合", paramType = "query", required = true, dataType = "String")
來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/31558068/viewspace-2847393/,如需轉載,請註明出處,否則將追究法律責任。
相關文章
- 最新 介面api外掛 Swagger3 更新配置詳解APISwagger
- Swagger3 更新配置詳解Swagger
- OD外掛詳解
- spket外掛詳解
- webpack4配置詳解之常用外掛分享Web
- maven-compiler-plugin外掛引數配置詳解MavenCompilePlugin
- [外掛擴充套件]更新IP外掛套件
- 配置vim外掛遇到youcompleteme外掛問題解決方案
- jQuery外掛開發模式詳解jQuery模式
- Gradle自定義外掛詳解Gradle
- xLua熱更新外掛
- 解決Nessus外掛更新失敗問題
- maven外掛配置Maven
- Fluttify輸出Flutter外掛工程詳解Flutter
- MyBatis(八):MyBatis外掛機制詳解MyBatis
- Vue.js 外掛開發詳解Vue.js
- 15 個最新的 jQuery外掛jQuery
- android 外掛字幕介面Android
- 阿里大師帶你詳解API介面安全阿里API
- 淘寶API介面AG文件接入呼叫方法詳解API
- Maven配置 Jetty 外掛MavenJetty
- SOFATracer 外掛埋點機制詳解
- IDEA的JRebel外掛使用詳解Idea
- jQuery上傳外掛Uploadify使用詳解jQuery
- 淘寶詳情api介面API
- 商品詳情API介面API
- AE外掛 Saber漢化最新版
- MyEclipse 最新svn外掛安裝Eclipse
- 分享10款最新的jQuery外掛jQuery
- FastDFS的配置、部署與API使用解讀(8)FastDFS多種檔案上傳介面詳解ASTAPI
- 淘寶API介面大全 電商API詳情API
- Swipe 移動端滑動外掛使用詳解
- 短網址生成API介面,短鏈生成 W外鏈API介面API
- Babel外掛原理與配置Babel
- myBatis分頁外掛配置MyBatis
- MybatisGenerator的Maven外掛配置MyBatisMaven
- MyEclipse 配置SVN外掛Eclipse
- MediaWiki配置Scribunto外掛