后端开发之Swagger API开发工具

Posted 2023-04-06 尘封的CPU

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了后端开发之Swagger API开发工具相关的知识，希望对你有一定的参考价值。

最近刚入职公司，做Java后端。当下对于新手程序员来说，的确并不友好，不仅是经济低迷，而且这次chatgpt的大火也极大地冲击了软件开发行业，所以小白必须抓紧时间卷，哪怕自己写出来的东西把自己搞失业……也要尽量多学一点是一点儿，今天咱们聊聊API开发文档插件swagger。

Swagger是一个流行的API开发工具，用于设计、构建、测试和文档化RESTful API。它是一种开放源代码的工具，旨在帮助开发人员更轻松地构建API。本文将介绍Swagger的原理、使用过程、用例等方面，并深入讨论Swagger的各个方面。

Swagger的原理

Swagger是一个基于JSON和YAML的工具，它使用文档化和自动化的方法来描述和测试RESTful API。它的核心原理是使用Swagger规范定义API，然后使用Swagger工具生成文档和代码。

Swagger规范定义了API的元数据，包括请求和响应的结构、参数、数据类型等。使用Swagger规范定义API，可以更轻松地创建、测试和文档化API，同时提高了API的可读性和可维护性。

Swagger工具使用这些元数据来生成文档和代码。它可以生成html文档、Markdown文档、PDF文档等，还可以生成客户端SDK、服务器端代码等。

2 / 2

Swagger的原理

Swagger工具使用这些元数据来生成文档和代码。它可以生成HTML文档、Markdown文档、PDF文档等，还可以生成客户端SDK、服务器端代码等。

Swagger的使用过程

使用Swagger创建API文档是非常简单的。以下是使用Swagger的基本过程：

在Java项目中添加Swagger依赖项。
在代码中使用Swagger注释和约定进行API定义。
运行Swagger工具生成API文档和代码。

以下是使用Swagger创建“Hello World”API的示例代码：

import io.swagger.annotations.*;
import org.springframework.web.bind.annotation.*;

@RestController
public class HelloWorldController 

    @ApiOperation(value = "Say hello", response = String.class)
    @GetMapping("/hello")
    public String helloWorld() 
        return "Hello World";

这段代码中，@ApiOperation注释定义了API的元数据，包括名称、描述和响应。@GetMapping注释定义了API的请求方法和路径。

使用Swagger工具生成API文档和代码非常简单。只需在命令行中运行swagger generate命令并指定API定义文件的路径即可。Swagger工具将生成HTML文档、Markdown文档、PDF文档等，并且可以生成客户端SDK、服务器端代码等。

Swagger的注解

Swagger使用注解来定义API元数据和约定。以下是一些常用的Swagger注解：

@Api：定义API的基本信息，包括名称、描述和版本号。
@ApiOperation：定义API操作的基本信息，包括名称、描述和响应类型。
@ApiParam：定义API参数的基本信息，包括名称、描述、数据类型和是否必需。
@ApiModel：定义数据模型的基本信息，包括名称、描述和属性列表。
@ApiModelProperty：定义数据模型属性的基本信息，包括名称、描述、数据类型和是否必需。
@ApiResponse：定义API操作的响应信息，包括状态码、描述和响应数据类型。
@ApiResponses：定义多个API操作的

SpringBoot集成Swagger

狂神视频
在这里插入图片描述
学习目标：

了解Swagger的概念及作用
掌握在项目中集成Swagger自动生成API文档

1、Swagger简介

前后端分离

前端 -> 前端控制层、视图层
后端 -> 后端控制层、服务层、数据访问层
前后端仅仅通过异步接口(AJAX/JSON)来编程
前后端都各自有自己的开发流程，构建工具，测试集合
前后端通过API进行交互
前后端相对独立且松耦合

开发流程

后台编写和维护接口文档，在 API 变化时更新接口文档
后台根据接口文档进行接口开发
前端根据接口文档进行开发
开发完成后联调和提交测试

在这里插入图片描述

产生的问题

没有统一的文档编写规范，导致文档越来越乱，无法维护和阅读。
开发中的接口增删改等变动，需要较大的沟通成本。
前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发

解决方案

首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险

Swagger

号称世界上最流行的API框架
Restful Api 文档在线自动生成器 => API 文档与API 定义同步更新
直接运行，在线测试API
支持多种语言（如：Java，PHP等）

swagger官网
 swagger中文网站

2、SpringBoot集成Swagger

SpringBoot集成Swagger => springfox，两个jar包

Springfox-swagger2
swagger-springmvc

使用Swagger要求

要求：jdk 1.8 + 否则swagger2无法运行

使用Swagger步骤

新建一个springboot-swagger-study项目
添加Maven依赖

<!-- 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>

编写HelloController，测试确保运行成功！

package com.spring.springbootswaggerstudy.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
    @RequestMapping("/hello")
    public String hello() {
        return "hello world";
    }
}

启动项目访问测试：http://localhost:8080/hello ,可以看到以下页面说明运行成功。
在这里插入图片描述
4. 要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  
}

访问测试：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；
配置swagger（整体）

package com.spring.springbootswaggerstudy.config;

import com.spring.springbootswaggerstudy.controller.HelloController;
import com.spring.springbootswaggerstudy.controller.HelloWorldController2;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {
    //多个Docket实现多组
    @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("A")
                .select()
                .apis(RequestHandlerSelectors.none())
                .build();
    }
    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B")
                .select()
                .apis(RequestHandlerSelectors.none())
                .build();
    }
    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C")
                .select()
                .apis(RequestHandlerSelectors.none())
                .build();
    }



    //配置了Swagger的Bean实例
    @Bean
    public Docket docket(Environment environment){
        //设置要显示的Swagger环境
        Profiles prfiles = Profiles.of("dev", "test");
        //通过environment.acceptsProfiles判断是否出处在自己设定的环境当中
        boolean flag=environment.acceptsProfiles(prfiles);
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("D")
                .enable(true)//enable是否启动Swagger，如果为false不启动，则不能在浏览器里访问Swagger如果为true启动Swagger
                .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                //RequestHandlerSelectors 扫描要配置接口的方式
                //basePackage 指定要扫描的包,根据包路径扫描接口
                .apis(RequestHandlerSelectors.basePackage("com.spring.springbootswaggerstudy.controller"))
                //any():扫描全部,项目中的所有接口都会被扫描到
                //none():全不扫描
                //withClassAnnotation(HelloController.class):扫描类上的注解
                //withMethodAnnotation(:扫描方法上的注解,扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
                //.apis(RequestHandlerSelectors.any())
                //paths():过滤路径,配置如何通过path过滤,即这里只扫描请求以/controller/开头的接口
                // .paths(PathSelectors.ant("/controller/**"))
                .build();
    }
    //配置Swagger信息=apiInfo
    private ApiInfo apiInfo(){
        //作者信息：参数一：作者姓名，参数二：作者访问链接，参数三：作者邮箱
        Contact contact=new Contact("D","http://www.apache.org/licenses/LICENSE-2.0","D的邮箱");
        return new ApiInfo("D的SwaggerAPI文档",//标题
                "swagger学习",//描述
                "v1.0",//版本
                "http://www.apache.org/licenses/LICENSE-2.0",//组织链接
                contact,//作者信息
                "Apache 2.0",//许可
                "http://www.apache.org/licenses/LICENSE-2.0",//许可链接
                new ArrayList()//扩展
        );
    }
}

在这里插入图片描述

3、配置Swagger步骤

Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2);
}

可以通过apiInfo()属性配置文档信息

//配置文档信息
private ApiInfo apiInfo() {
   Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
   return new ApiInfo(
           "Swagger学习", // 标题
           "学习演示如何配置Swagger", // 描述
           "v1.0", // 版本
           "http://terms.service.url/组织链接", // 组织链接
           contact, // 联系人信息
           "Apach 2.0 许可", // 许可
           "许可链接", // 许可连接
           new ArrayList<>()// 扩展
  );
}

Docket 实例关联上 apiInfo()

@Bean
public Docket docket() {
   return new 
   Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

重启项目，访问测试 http://localhost:8080/swagger-ui.html 看下效果；

4、配置扫描接口

构建Docket时通过select()方法配置怎么扫描接口。

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
      .build();
}

重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类
除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口，这里注释一下所有的配置方式：

any() // 扫描所有，项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口

除此之外，我们还可以配置接口扫描过滤：

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/kuang/**"))
      .build();
}

这里的可选值还有

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

5、配置Swagger开关

通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/kuang/**"))
      .build();
}

如何动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示？

@Bean
public Docket docket(Environment environment) {
   // 设置要显示swagger的环境
   Profiles of = Profiles.of("dev", "test");
   // 判断当前是否处于该环境
   // 通过 enable() 接收此参数判断是否要显示
   boolean b = environment.acceptsProfiles(of);
   
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(b) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.spring.springbootswaggerstudy.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/controller/**"))
      .build();
}

可以在项目中增加一个dev的配置文件查看效果！

6、配置API分组

在这里插入图片描述
4. 如果没有配置分组，默认是default。通过groupName()方法即可配置分组：

@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("hello") // 配置分组
       // 省略配置....
}

重启项目查看分组
如何配置多个分组？配置多个分组只需要配置多个docket即可：

@Bean
public Docket docket1(){A
   return new Docket(DocumentationType.SWAGGER_2).groupName("A");
}
@Bean
public Docket docket2(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("B");
}
@Bean
public Docket docket3(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("C");
}

重启项目查看即可

7、实体配

新建一个实体类

@ApiModel("用户实体")
public class User {
   @ApiModelProperty("用户名")
   public String username;
   @ApiModelProperty("密码")
   public String password;
}

只要这个实体在请求接口的返回值上（即使是泛型），都能映射到实体项中：

@RequestMapping("/getUser")
public User getUser(){
   return new User();
}

重启查看测试

注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，
而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。
@ApiModel为类添加注释
@ApiModelProperty为类属性添加注释

8、常用注解

Swagger的所有注解定义在io.swagger.annotations包下

下面列一些经常用到的，未列举出来的可以另行查阅说明：
Swagger的所有注解定义在io.swagger.annotations包下

下面列一些经常用到的，未列举出来的可以另行查阅说明：

Swagger注解	简单说明
@Api(tags = “xxx模块说明”)	作用在模块类上,用在类上，说明该类的作用@Api(value = “UserController”, description = “用户相关api”)
@ApiOperation(“xxx接口说明”)	作用在接口方法上 ,用在方法上，说明方法的作用@ApiOperation(value = “查找用户”, notes = “查找用户”, httpMethod = “GET”, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@ApiModel(“xxxPOJO说明”)	作用在模型类上：如VO、BO;描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）@ApiModel(value = “用户实体类”)
@ApiModelProperty(value = “xxx属性说明”,hidden = true)	作用在类方法和属性上，hidden设置为true可以隐藏该属性;描述一个model的属性@ApiModelProperty(value = “登录用户”)
@ApiParam(“xxx参数说明”)	作用在参数、方法和字段上，类似@ApiModelProperty
@ApiIgnore	如果应用在Controller范围上，则当前Controller中的所有方法都会被忽略，如果应用在方法上，则对应用的方法忽略暴露API。
@ApiImplicitParams	用在方法上包含一组参数说明
@ApiImplicitParam	用在@ApiImplicitParams注解中，指定一个请求参数的各个方面paramType：参数放在哪个地方header–>请求参数的获取：@RequestHeaderquery–>请求参数的获取：@RequestParampath（用于restful接口）–>请求参数的获取：@PathVariablebody（不常用）form（不常用）name：参数名dataType：参数类型required：参数是否必须传value：参数的意思defaultValue：参数的默认值@ApiImplicitParams({@ApiImplicitParam(name = “id”,value = “唯一id”, required = true, dataType = “Long”, paramType = “path”),})
@ApiResponses	用于表示一组响应
@ApiResponse	用在@ApiResponses中，一般用于表达一个错误的响应信息code：数字，例如400message：信息，例如”请求参数没填好”response：抛出异常的类@ApiResponses(value = { @ApiResponse(code = 400, message = “NoName Provided”) })

@RestController
@RequestMapping("/users")
@Api(value = "user", description = "用户管理", produces = MediaType.APPLICATION_JSON_VALUE)
public class UserController {
    @RequestMapping(value = "/get", method = RequestMethod.GET)
    @ApiOperation(value = "获取用户接口", notes = "获取用户接口详细描述")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "header", dataType="string", name = "token", value = "访问凭证", required = true),
    })
    public User getUser(String username, String password) {
        return new User(username,password);
    }

    @RequestMapping(value = "/post", method = RequestMethod.POST)
    @ApiOperation(value = "创建用户接口", notes = "创建用户接口详细描述")
    public Map<String, Object> post(User user) {
        System.out.println(user);
        HashMap<String, Object> map = Maps.newHashMap();
        map.put("username", "are you ok");
        map.put("password", "ok");
        return map;
    }
		}

在这里插入图片描述
我们也可以给请求的接口配置一些注释

@ApiOperation("name的接口")
@PostMapping("/name")
@ResponseBody
public String name(@ApiParam("这个名字会被返回")String username){
   return username;
}

Swagger rest API 描述

064Spring Boot如何让Web API自动生成文档，并解决swagger-annotations的API注解description属性废弃的问题

SpringBoot集成Swagger

java小技能：Swagger （RESTful 风格的 Web 服务框架）

SpringBoot项目集成Swagger2

springboot 集成swagger2