springboot+swagger2说明

时间:2025-03-17 22:45:47
  • package ;  
  •   
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ;  
  • import ..EnableSwagger2;  
  •   
  • import ;  
  •   
  • /** 
  •  * @description: swagger2配置文件类 
  •  * @访问路径: 如 http://localhost:8080/ 
  •  * @author fanpeng 
  •  * @create 2017-01-03 10:00 
  •  * @Modify By: 
  •  **/  
  • @Configuration  
  • @EnableSwagger2  
  • @ConfigurationProperties  
  • public class Swagger2Config {  
  •     @Value("${}"private String version;  
  •     @Value("${}"private String basePackage;  
  •   
  •     @Bean  
  •     public Docket createRestApi() {  
  •         return new Docket(DocumentationType.SWAGGER_2)  
  •                 .apiInfo(apiInfo())  
  •                 .groupName("travel")  
  •                 .genericModelSubstitutes(DeferredResult.class)  
  •                 .useDefaultResponseMessages(false)  
  •                 .globalResponseMessage(,customerResponseMessage())  
  •                 .forCodeGeneration(true)  
  •                 .select()  
  •                 .apis((basePackage))  
  •                 .apis((ApiOperation.class))  
  •                 .paths(())  
  •                 .build();  
  •     }  
  •   
  •     private ApiInfo apiInfo() {  
  •         return new ApiInfoBuilder()  
  •                 .title("国安社区-travel接口")  
  •                 .description("I'm description..")  
  •                 .contact("东哥")  
  •                 .version(version)  
  •                 .license("国安社区")  
  •                 .licenseUrl("")  
  •                 .build();  
  •     }  
  •   
  •     /** 
  •      * 自定义返回信息 
  •      * @param 
  •      * @return 
  •      */  
  •     private List<ResponseMessage> customerResponseMessage(){  
  •         return (  
  •                 new ResponseMessageBuilder()//500  
  •                         .code(())  
  •                         .message(())  
  •                         .responseModel(new ModelRef("Error"))  
  •                         .build(),  
  •                 new ResponseMessageBuilder()//401  
  •                         .code(())  
  •                         .message(())  
  •                         .build());  
  •     }  
  •   
  •   
  • }