【谷粒学院】005-整合Swagger

訾博ZiBo

发布于 2025-01-06 16:49:19

5900

代码可运行

文章被收录于专栏：全栈开发工程师全栈开发工程师

运行总次数：0

代码可运行

一、Swagger2介绍

前后端分离开发模式中，api文档是最好的沟通方式。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

1. 及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)；

2. 规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)；

3. 一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)；

4. 可测性 (直接在接口文档上进行测试，以方便理解业务)；

二、配置Swagger2

1、在父工程guli_parent创建common公共模块，删除src目录

2、在common中引入相关依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>guli_parent</artifactId>
        <groupId>com.zibo</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>common</artifactId>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <scope>provided </scope>
        </dependency>
        <!--mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <scope>provided </scope>
        </dependency>
        <!--lombok用来简化实体类：需要安装lombok插件-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided </scope>
        </dependency>
        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <scope>provided </scope>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <scope>provided </scope>
        </dependency>
        <!-- redis -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <!-- spring2.X集成redis所需common-pool2
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-pool2</artifactId>
             <version>2.6.0</version>
         </dependency>-->
    </dependencies>

</project>

3、在common下面创建子模块service_base

4、创建配置类

（由于出现了一些问题，我重新创建了项目，项目名为edu_parent，其他不变）

package com.zibo.servicebase;

import com.google.common.base.Predicates;
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.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;

@Configuration //配置类
@EnableSwagger2 //swagger注解
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }
    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("网站-课程中心API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("Helen", "http://atguigu.com",
                        "55317332@qq.com"))
                .build();
    }
}

5、为service_edu模块的启动类添加注解，使其能够扫描到common模块下service_edu的包

（但这样并没有达到目的）

package com.zibo.edu;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;

@SpringBootApplication
@ComponentScan(basePackages = {"com.zibo"})//设置扫描组件的的目标包路径
public class EduApplication {
    public static void main(String[] args) {
        SpringApplication.run(EduApplication.class,args);
    }
}

6、在service模块依赖中引入service_edu模块

        <dependency>
            <groupId>com.zibo</groupId>
            <artifactId>service_base</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

7、启动项目，访问http://localhost:8001/swagger-ui.html

8、测试使用delete提交删除讲师

（我在数据库中提前把张三的is_deleted字段改成了0）

进行测试：

测试结果：

数据库表截图：

9、配置一些提示信息

定义在类上：@Api

@Api(tags = {"教师管理模块TeacherController"})

定义在方法上：@ApiOperation

定义在参数上：@ApiParam

修改Controller：

package com.zibo.edu.controller;


import com.zibo.edu.entity.Teacher;
import com.zibo.edu.service.TeacherService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**
 * <p>
 * 讲师 前端控制器
 * </p>
 *
 * @author zibo
 * @since 2020-11-30
 */
@RestController
@RequestMapping("/edu/teacher")
@Api(tags = {"教师管理模块TeacherController"})
public class TeacherController {
    @Autowired
    private TeacherService teacherService;

    //查询所有
    @ApiOperation("查询所有")
    @RequestMapping("/findall")
    public List<Teacher> findAll(){
        return teacherService.list(null);
    }

    //逻辑删除
    @ApiOperation("逻辑删除")
    @RequestMapping("{id}")//id通过路径传过来
//    @DeleteMapping("{id}")
    public boolean hide(@ApiParam("要删除教师的ID") @PathVariable("id")String id){
        return teacherService.removeById(id);
    }
}