Swagger使用

swagger的使用超级简单(只要不是研究特别深只是用用的话)

首先当然是添加依赖咯

io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2 com.google.guava guava 20.0 com.fasterxml.jackson.core jackson-databind 2.9.5 com.fasterxml.jackson.core jackson-core 2.9.5 com.fasterxml.jackson.core jackson-annotations 2.9.5

 

然后添加配置文件

@Configuration @EnableSwagger2 @ConditionalOnProperty(prefix = "swagger", name = "button-open", havingValue = "true") public class SwaggerConfig { /** * 创建获取api应用 * @return */ @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .host("localhost:8080") .select() //这里采用包含注解的方式来确定要显示的接口(建议使用这种) .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) // .apis(RequestHandlerSelectors.basePackage("com.tbtx.member_user.controller")) //这里采用包扫描的方式来确定要显示的接口 .paths(PathSelectors.any()) .build(); } /** * 配置swagger文档显示的相关内容标识(信息会显示到swagger页面) * @return */ private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("swagger使用") .description("http://") .termsOfServiceUrl("http://swagger.io/") .contact(new Contact("xiaoli", "https://mp.csdn.net/", "[email protected]")) .version("1.0") .build(); } }

然后就可以去启动类中添加一个注解

然后去controller类中，在类上添加 Api 注解，不是在方法上添加哦

然后就可以在每个方法上添加

参数含义都在下面

本地访问路径:  http://localhost:8080/swagger-ui.html#!