- Swagger
是一个规范,完整的框架;用于生成、描述、调用和可视化 RESTful 风格的Web 服务 - 相关依赖
- 配置类
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket webApiConfig() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
.paths(Predicates.not(PathSelectors.regex("/admin/.*")))
.paths(Predicates.not(PathSelectors.regex("/error.*")))
.build();
}
private ApiInfo webApiInfo() {
return new ApiInfoBuilder()
.title("API文档")
.description("本文档描述了微服务接口定义")
.version("1.0")
.contact(new Contact("姓名", "网站",
"邮箱"))
.build();
}
}
- 启动服务,访问Swagger UI
http://ip:端口号/swagger-ui.html