在项目中使用swagger

https://swagger.io/

swagger2，
ui
2个jar包

springboot集成Swagger

1新建一个springboot-web项目
依赖：
https://mvnrepository.com/artifact/io.springfox/springfox-swagger2
https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui

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

2编写一个helloworld,注意同级，子级，写一个controller，然后返回页面，
3配置Swagger-->写一个config-->@Configuration

@Configuration
@EnableSwagger2     //需要开启Swagger2，注意版本
public class SwaggerConfig {
}

4测试运行，访问一个页面
http://localhost:8080/swagger-ui.html

配置Swagger信息

config文件夹，新建一个类

package com.xuwen.swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

/**
 * author:xuwen
 * Created on 2021/8/5
 */

@Configuration
@EnableSwagger2     //需要开启Swagger2，注意版本
public class SwaggerConfig {

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

    //配置swagger信息=apiinfo
    private ApiInfo apiInfo(){
        //作者信息s
       Contact contact = new Contact("作者信息文文", "", "betsyxw@gmail.com");

       return new ApiInfo(
               "Swagger 团队协作",
               "即使再小的帆也能远航",
               "v1.0",
               "http://localhost",
               contact,
               "Apache 2.0",
               "http://www.apache.org/licenses/LICENSE-2.0",
               new ArrayList());

    }

}

Swagger配置扫描接口

Docket.select()

配置api文档分组

配置多个分组，多人协作开发

public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //配置扫描哪个包
                .apis(RequestHandlerSelectors.basePackage("com.xuwen.swagger.controller"))
                .build();
    }
    
    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B组");
    }

    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C组");
    }

package com.xuwen.swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

/**
 * author:xuwen
 * Created on 2021/8/5
 */

@Configuration
@EnableSwagger2     //需要开启Swagger2，注意版本
public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //配置扫描哪个包
                .apis(RequestHandlerSelectors.basePackage("com.xuwen.swagger.controller"))
                .build();
    }

    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B组");
    }

    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C组");
    }

    //配置swagger信息=apiinfo
    private ApiInfo apiInfo(){
        //作者信息s
       Contact contact = new Contact("作者信息文文", "", "betsyxw@gmail.com");

       return new ApiInfo(
               "Swagger 团队协作",
               "即使再小的帆也能远航",
               "v1.0",
               "http://localhost",
               contact,
               "Apache 2.0",
               "http://www.apache.org/licenses/LICENSE-2.0",
               new ArrayList());

    }

}

实体类配置