自学笔记-Swagger2

1、简介

• Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
• Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测。

2、导入需要的相关依赖

3、编写自己的controller类

分别有 get、post、put、delete

4、在config中配置Swagger

5、测试运行

6、配置Swagger

首先配置Swagger的Docket的Bean实例
阅读Docket源码可得
里面需要传递一个DocumentationType类型的参数


由于这里它的ApiInfo是默认的
而我们需要传入一个apiInfo，因而我们需要自己配置一个Swagger信息（apiInfo）
这里小小的配置了一波

7、Swagger配置扫描接口

Docket.select()

return new Docket(DocumentationType.SWAGGER_2 )
      .apiInfo(apiInfo())
       //.enable(false)
      .select()
      .apis(RequestHandlerSelectors.basePackage("com.gench.hzh.controller"))//扫描方法上的注解
      .build();

8、如何只在生成环境中使用

• 判断是不是生产环境 flag = false
• 注入enable(flag)

9、配置API文档的分组

10、一些常用注解