前言技术：swagger

2023-11-05

1. 前后端分离的特点

前后端分离是的前端与后端之间的职责更加明确

后台：负责业务处理

前端：负责显示逻辑

在这种情况下，前端和后端可以分别交付给专业的开发人员去做，所以是必须要定义前后端直接的对接

接口，否则各自为是则项目无法集成，这时就需要一个文档来定义统一的接口。

2. 在没有swagger之前

在没有 swagger 之间，我们可以使用 word ， excel 等功能来书写接口定义文档，但又有一个弊端，即：

在接口发送改变时需要及时的同步接口文档，否则实际的接口与接口文档不相符，则接口文件就失去了

作用，甚至会起到反作用。

3. swagger的作用

根据在代码中使用自定义的注解来生成接口文档，这个在前后端分离的项目中很重要。这样做的好处是

在开发接口时可以通过 swagger 将接口文档定义好，同时也方便以后的维护。

4. swagger的优点

号称时最流行的 API 框架

接口文档在线生成，避免同步的麻烦

可以支持在线对接口执行测试

支持多语言

5. 集成swagger

5.1 新建springboot项目

使用集成开发工具创建一个 springboot 工程

5.2 集成swagger

1. 打开 https://mvnrepository.com/ ，查找 springbox ，在 pom.xml 中导入如下图标出的依赖。

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

1. 编写swagger的配置类

package com.zking.mini_program.configuration;

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;

@SuppressWarnings("all")
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zking.mini_program.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SwaggerDemo API DOC")
                .description("SwaggerDemo API DOC")
                .version("1.0")
                .termsOfServiceUrl("https://www.yyqx.com")
                .build();
    }

}

5.4 启动服务，验证集成效果

服务启动后，访问：http://localhost:8080/swagger-ui.htm

注：设置访问方式为Post

6. swagger常用注解

常用注解列表：

required="true" 表示参数是否必须传 |

更全面的信息可以参考官方说明文档：

swagger-annotations 1.3.10 API

API 名称

[GET] http:

测试接口

请求参数

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

前端