pom加入swagger的依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.0</version>
</dependency>
加入swagger的配置
通过项目根路径,加入swagger-ui.html访问
注意:在接口的方法上加上注解,方便理解
@ApiOperation(value = "此接口的作用",notes = "接口备注信息")
明确指出该接口支持的访问方式,比如GET,POST,否则该接口会出现所有方式的同样接口,不便查看
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.0</version>
</dependency>
加入swagger的配置
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket createRestApi(){ Docket docket = new Docket(DocumentationType.SWAGGER_2); docket.apiInfo(apiInfo()); ApiSelectorBuilder apiSelectorBuilder = docket.select(); apiSelectorBuilder.apis(RequestHandlerSelectors.basePackage("com.xxx.swaggerhello.web.controller")); //设置为上面basePackage包下面的哪些class生成接口信息 apiSelectorBuilder.paths(PathSelectors.any()); docket = apiSelectorBuilder.build(); return docket; } private ApiInfo apiInfo(){ ApiInfoBuilder apiInfoBuilder = new ApiInfoBuilder(); apiInfoBuilder.title("测试springMVC 添加swagger来查看对外提供的接口信息"); apiInfoBuilder.description("通过swagger来查看接口的具体信息,以及测试接口"); apiInfoBuilder.termsOfServiceUrl("联系你的网站); Contact contact = new Contact("个人或者公司名称","网站主页","个人/网站邮箱"); apiInfoBuilder.contact(contact); apiInfoBuilder.version("1.0"); ApiInfo apiInfo = apiInfoBuilder.build(); return apiInfo; } }
通过项目根路径,加入swagger-ui.html访问
注意:在接口的方法上加上注解,方便理解
@ApiOperation(value = "此接口的作用",notes = "接口备注信息")
明确指出该接口支持的访问方式,比如GET,POST,否则该接口会出现所有方式的同样接口,不便查看