Swagger 3.0使用教程(转载)

原文地址

https://blog.csdn.net/weixin_44203158/article/details/109137799

 

swagger介绍

Swagger 是一套基于 OpenAPI 规范（OpenAPI Specification，OAS）构建的开源工具，后来成为了 Open API 标准的主要定义者。
对于 Rest API 来说很重要的一部分内容就是文档，Swagger 为我们提供了一套通过代码和注解自动生成文档的方法，这一点对于保证API 文档的及时性将有很大的帮助。

swagger2于17年停止维护，现在最新的版本为17年发布的 Swagger3（Open Api3）。

 

 

注意：

Maven项目中引入springfox-boot-starter依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

 

使用@EnableOpenApi注解Controller类，启用swagger配置

@EnableOpenApi
@Configuration
public class SwaggerController {

}