springboot--整合在线文档生成工具swagger

最新推荐文章于 2024-09-20 12:07:59 发布

密码11位

最新推荐文章于 2024-09-20 12:07:59 发布

阅读量281

点赞数

分类专栏： swagger在线文档文章标签： spring boot java

本文链接：https://blog.csdn.net/weixin_43393069/article/details/108433655

版权

swagger在线文档专栏收录该内容

1 篇文章 0 订阅

订阅专栏

导入依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!--swagger-->
        <!-- 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>

实体类

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

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

配置类

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.RequestHandler;
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;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket docket0(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("AAA");
    }

    @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("BBB");
    }
    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("CCC");
    }

    @Bean
    public Docket docket(Environment environment){

        Profiles profiles = Profiles.of("dev", "test");

        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("harbin")//配置API文档的分组
                .enable(flag)//是否启动Swagger,如果为false，则swagger不能在浏览器访问
                .select()
                //RequestHandlerSelectors配置要扫描接口的方式
                /*
                any() 扫描所有
                none() 都不扫描
                withMethodAnnotation(GetMapping.class) 扫描有这个方法注解的
                withClassAnnotation(Controller.class) 扫描带着个类注解的
                basePackage("com.harbin.controller") 扫描这个包
                 */
                .apis(RequestHandlerSelectors.basePackage("com.harbin.controller"))
                //过滤路径
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {

        Contact contact = new Contact("HarBin", "localhost", "1280143402@qq.com");
        return new ApiInfo(
                "HarBin's SwaggerAPI文档",
                "只要学不死，就往死里学",
                "v1.0",
                "http://www.harbin.com",
                contact,
                "Apache2.0",
                "http://www.apache.org",
                new ArrayList<>()
        );
    }


}

控制层

import com.harbin.pojo.User;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello(){
        return "hello";
    }

    @ApiOperation("方法上的")
    @GetMapping("/hello2")
    public String hello2(@ApiParam("用户名") String username){
        return "hello2"+username;
    }

    //只要接口中返回值中存在实体类，就会被扫描到Swagger中
    @PostMapping("/user")
    public User user(){
        return new User();
    }

    @ApiOperation("测试Swagger的测试")
    @PostMapping("/postuser")
    public User postuser(@ApiParam("用户信息") User user){
        return user;
    }
}

主配置


@SpringBootApplication
@EnableSwagger2
public class SwaggerDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(SwaggerDemoApplication.class, args);
    }

}