您的位置:首页 > 编程语言 > Java开发

Spring boot结合swagger自动生成api文档

2017-05-31 16:19 1201 查看
首先需要在工程中加入以下依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.2.2</version>
</dependency>

版本随意。

然后创建自己的swagger类:@Configuration
@EnableSwagger2
public class Swagger2 {

@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.myweb.Controller"))//注解1
.paths(PathSelectors.any())
.build();
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("更多Spring Boot相关文章请关注:http://blog.didispace.com/")
.termsOfServiceUrl("http://blog.didispace.com/")
.contact("作者")
.version("1.0")
.build();
}

}如上代码所示,通过
@Configuration
注解,让Spring来加载该类配置。再通过
@EnableSwagger2
注解来启用Swagger。
注解1是你的接口所在的文件夹(包),

启动springboot然后访问http://localhost:8080/swagger-ui.html就可以了,注意自己有没有改端口。
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签:  Springboot swagger