使用Swagger自动生成文档

Posted xy-ouyang

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了使用Swagger自动生成文档相关的知识,希望对你有一定的参考价值。

1、maven依赖

  maven仓库(https://mvnrepository.com/)搜索springfox

技术图片

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

 

2、springboot集成swagger2

  1)创建一个springboot项目,pom.xml引入上面贴出的两个依赖jar;

  2)在springboot启动类上加注解@EnableSwagger2;

  3)启动项目,在浏览器输入localhost:8081/swagger-ui.html

 

3、swagger2常用的注解

 

以上是关于使用Swagger自动生成文档的主要内容,如果未能解决你的问题,请参考以下文章

Swagger文档后端接口文档生成工具的使用

使用swagger有办法自动生成文档吗

使用swagger有办法自动生成文档吗

使用Swagger自动生成文档

如何在Nancy中使用Swagger生成API文档?

使用Swagger生成简单接口文档