springboot2 整合swagger2

àì夳堔傛蜴生んèń 2021-09-20 00:46 421阅读 0赞

一、pom中引入swagger

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

二、SwaggerConfig

@Configuration
    @EnableSwagger2
    public class SwaggerConfig {
       @Resource
       private TypeResolver typeResolver;
    
       public SwaggerConfig() {
       }
    
       private ApiInfo apiInfo() {
          Contact contact = new Contact("ppp", null, "ppp");
          return (new ApiInfoBuilder()).contact(contact).title("tlnc - Web").description("消息中心")
                .version("1.1.0").build();
       }
    
    
    
       private List<ApiKey> securitySchemes() {
          return Lists.newArrayList(new ApiKey[] { new ApiKey("Token", "Token", "Header") });
       }
    
    
       @Bean
       public Docket allApi(){
          return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder().title("全部接口列表").description("全部接口列表").version("1.0.0").build())
                .groupName("All")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.ms"))
                .paths(PathSelectors.any())
                .build();
       }
    
       @Bean
       public Docket createRestApi() {
    
          ParameterBuilder tokenPar = new ParameterBuilder();
          List<Parameter> pars = new ArrayList<>();
          pars.add(tokenPar.name("Token").description("令牌")
                .modelRef(new ModelRef("string")).parameterType("header").required(true).build());
          return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .apiInfo(apiInfo())
                .groupName("外部接口")
                .genericModelSubstitutes(DeferredResult.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(true)
                .pathMapping("/")
                .select()
                .paths(PathSelectors.regex("/api/.*"))
                .build()
                .globalOperationParameters(pars);
    
    
       }
    
       @Bean
       public Docket createWebApi() {
             ParameterBuilder tokenPar = new ParameterBuilder();
          List<Parameter> pars = new ArrayList<>();
          pars.add(tokenPar.name("Token").description("令牌")
                .modelRef(new ModelRef("string")).parameterType("header").required(true).build());
          return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("内部接口")
                .genericModelSubstitutes(DeferredResult.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(true)
                .pathMapping("/")
                .select()
                .paths(PathSelectors.regex("/web/.*"))
                .build();
       }
    }

三、controller注解

@ApiResponses(value = {@ApiResponse(code = 200, message = "0,成功,其它为错误")})
       @ApiOperation(value = "删除数据", notes = "删除数据", produces = "application/json")
       @RequestMapping(value = "/msg/del", method = RequestMethod.POST)
       public BaseResponse msgDelete(@ApiParam(value = "删除数据", required = true) @RequestBody Msg msg) {

四、访问地址

[http://localhost/tcweb/swagger-ui.html][http_localhost_tcweb_swagger-ui.html]

五、生成json文件

在

SwaggerConfig.java中配置

.apiInfo(new ApiInfoBuilder().title("全部接口列表").description("全部接口列表").version("1.1.0").build())

访问[http://][http][localhost][http_localhost_tcweb_swagger-ui.html][/tc/v2/api-docs?group=All][http]，可获取到json文件

[http_localhost_tcweb_swagger-ui.html]: http://10.10.84.105/tlnc/swagger-ui.html
[http]: http://10.10.84.105/tlnc/v2/api-docs?group=All