swagger2的使用

导入swagger2的依赖:

		<!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>

创建一个配置类,添加swagger的配置信息:

package com.lpp.hospappoint.common.config;

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;

/**
 * Swagger2配置信息
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean 
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
//                方式1.显示添加ApiOperation注解的方法
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
//                .paths(PathSelectors.any())

//                方式2.只显示api路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/api/.*")))
                .build();


    }

    @Bean
    public Docket adminApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")
                .apiInfo(adminApiInfo())
                .select()
                //只显示admin路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();

    }
//页面的其他描述信息
    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()
                .title("网站-API文档")
                .description("本文档描述了网站微服务接口定义")
                .version("1.0")
                .contact(new Contact("lpan", "http://lpan.com", "12345678@qq.com"))
                .build();
    }

    private ApiInfo adminApiInfo(){

        return new ApiInfoBuilder()
                .title("后台管理系统-API文档")
                .description("本文档描述了后台管理系统微服务接口定义")
                .version("1.0")
                .contact(new Contact("lpan", "http://lpan.com", "12345678@qq.com"))
                .build();
    }


}

定义接口

@Api(tags = "测试")
@RestController
@RequestMapping("/admin/swagger/test")
public class TestController {

	@ApiOperation(value = "获取信息")
    @GetMapping("getInfo")
    public Result getInfo() {
        return Result.ok();
    }
   
    @GetMapping("getOneById")
    public Result getOneById() {
        return Result.ok();
    }
    
    @PostMapping("save")
    public Result save() {
        return Result.ok();
    }
}

输入网址:http://localhost:8201/swagger-ui.html:
按照方式1,获取添加ApiOperation注解的所有控制器方法:
在这里插入图片描述

按照方式2,获取api路径下的所有控制器方法:
在这里插入图片描述


版权声明:本文为qxyx1213原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。