swagger整合springboot

先來幾張swagger2markup導(dǎo)出文件圖

一、 maven依賴添加

<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency>

這里有一個(gè)注意點(diǎn)，swagger2內(nèi)置依賴的guava版本最少也是20，一般項(xiàng)目里面多多少少可能會有其他guava依賴，如果版本低于20，那么就應(yīng)該去除其他guava依賴，否則項(xiàng)目啟動失敗。

<exclusions><exclusion><groupId>com.google.guava</groupId><artifactId>guava</artifactId></exclusion></exclusions>

二、application.properties

swagger.enable=true

三、核心配置類Swagger2Configuration

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; 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;@Configuration @EnableSwagger2 @ConditionalOnProperty(name = "swagger.enable",havingValue ="true") public class Swagger2Configuration {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.xxx.controller")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("swagger2markup導(dǎo)出API文檔").description("你好啊").termsOfServiceUrl("http://www.baidu.com/").version("1.0.0").build();} }

ok，以上就能完成swagger整合springboot的一個(gè)步驟。

使用swagger2markup導(dǎo)出文檔

從idea導(dǎo)出項(xiàng)目：https://github.com/Swagger2Markup/swagger2markup.git
本質(zhì)上swagger2markup需要的只是一份json數(shù)據(jù)，只需要提供一份swagger的json就行了（路徑http://localhost:8080/v2/api-docs數(shù)據(jù)）。所以我們只需要修改swagger2markup的指向路徑。

pom.xml

<configuration><!--修改成你需要導(dǎo)出文檔的那個(gè)路徑--><swaggerInput>http://localhost:8081/v2/api-docs</swaggerInput><outputDir>${generated.asciidoc.directory}</outputDir><config><swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage><swagger2markup.pathsGroupedBy>TAGS</swagger2markup.pathsGroupedBy><swagger2markup.extensions.dynamicOverview.contentPath>${project.basedir}/src/docs/asciidoc/extensions/overview</swagger2markup.extensions.dynamicOverview.contentPath><swagger2markup.extensions.dynamicDefinitions.contentPath>${project.basedir}/src/docs/asciidoc/extensions/definitions</swagger2markup.extensions.dynamicDefinitions.contentPath><swagger2markup.extensions.dynamicPaths.contentPath>${project.basedir}/src/docs/asciidoc/extensions/paths</swagger2markup.extensions.dynamicPaths.contentPath><swagger2markup.extensions.dynamicSecurity.contentPath>${project.basedir}src/docs/asciidoc/extensions/security/</swagger2markup.extensions.dynamicSecurity.contentPath><swagger2markup.extensions.springRestDocs.snippetBaseUri>${swagger.snippetOutput.dir}</swagger2markup.extensions.springRestDocs.snippetBaseUri><swagger2markup.extensions.springRestDocs.defaultSnippets>true</swagger2markup.extensions.springRestDocs.defaultSnippets></config></configuration>

其余就不用操作了。

導(dǎo)出文檔操作

總結(jié)

以上是生活随笔為你收集整理的使用swagger2markup导出API接口文档的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。