swagger2的使用

最新推荐文章于 2024-05-17 17:13:24 发布

Eternity

最新推荐文章于 2024-05-17 17:13:24 发布

阅读量718

点赞数

本文链接：https://blog.csdn.net/qq_44614137/article/details/129114537

版权

Swagger2的使用

一、Swagger的作用
二、Swagger的使用
三、 swagger相关注解

一、Swagger的作用

首先我们学习一个技术时，应该想到它有什么作用吧！没啥好处，也没啥优点，估计没人学习吧，哈哈哈，那接下来看看Swagger有啥好处吧。
在之前时，后端与前端之间对接接口时，前端会问后端，你传的参数是哪几个啊？那个参数是不能为空的呢？。。。。可能会导致项目进度很慢，那么有了swagger，它其实就是一个来管理我们的接口API文档的一个工具，前端打开接口文档一看就会很清楚。节约时间，提高效率！！！

二、Swagger的使用

这里使用SpringBoot整合Swagger。

1.导入jar包

首先使用这个工具，我们就要有它的依赖包吧，这里使用maven的方式导入jar包。
这里提供一个maven下载jar包的工具
链接: https://mvnrepository.com/

使用swagger需要在pom.xml文件导入两个依赖包
swagger-ui和swagger2，我选了一个使用量最多的一个版本！！！

<!-- 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>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

2.编写一个简单的controller层，用于测试

在这里插入图片描述

3.配置swagger

建一个config配置文件，SwaggerConfig
这里需要介绍两个注解 "@Configuration 和@EnableSwagger2"
"@Configuration" 注解表示这是一个配置类，也就是说当程序运行时，就会被加载。
"@EnableSwagger2" 这个注解是Swagger的特有注解，表示是Swagger的配置。
在这里插入图片描述

4.测试

在启动项目是报了一个错误，嗯，，，，解决下这个报错，在继续
在这里插入图片描述
原因分析：一看就是什么版本问题了，应该是我的jdk版本和配置的发行版本不一致吧！！

但是我配置了也没有用，结果是自己挖的坑，我的pom文件配置的jdk是17，，，

改成8之后，还是报错，就是换了一个不同的报错信息，额，，，，
在这里插入图片描述
这个报错就是springBoot的版本太高了，降下版本就可以启动成功了！！！

从这里就可以看到springboot框架整合了tomcat服务器，默认端口8080，我们浏览器访问测试一下swagger

配置swagger的相关信息

上面的测试都是swagger的默认配置，在项目开发中都有自己的项目名称之类的，接下来配置自己的相关信息！！

需要创建一个Docket对象，以及ApiInfo的信息
看下ApiInfo对象的构造参数的源码
定义了标题，描述，版本，作者个人信息等等。
在这里插入图片描述

但是如果我们不想让生产环境看到我们的接口文档，就需要配置项目的环境，激活dev环境

在application.properties文件激活dev环境，
"spring.profiles.active=dev"
此时，我们再访问8080的端口时，就会报网页找不到，但是8081就可以访问得到了
8080 在这里插入图片描述
8081

在这里插入图片描述

package com.xingxing.springboot.config;


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.PathSelectors;
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;
import java.util.Properties;

/**
 * @author Administrator
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket docket(Environment environment){
        //激活dev环境
        Profiles profiles=Profiles.of("dev");
        boolean files=environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                生成api的controller文件
                .apis(RequestHandlerSelectors.basePackage("com.xingxing.springboot.controller"))
                .paths(PathSelectors.any())
                .build()
                .enable(files);

    }
    //配置swagger信息
    private ApiInfo apiInfo(){
        //定义文档的个人信息
        Contact contact=new Contact("chen"," ","");
        return new ApiInfo(
                "我的测试SwaggerAPI文档",
                "不学习，变垃圾！！！",
                "v1.0",
               null,
                "",
                "",
                null
        );
    }

}