oss-lib-swagger

Better swagger lib for spring-boot application

License	License MIT License
Categories	Categories Swagger Program Interface REST Frameworks
GroupId	GroupId cn.home1
ArtifactId	ArtifactId oss-lib-swagger
Last Version	Last Version 1.0.8.OSS
Release Date	Release Date Aug 24, 2017
Type	Type xml
Description	Description oss-lib-swagger Better swagger lib for spring-boot application
Project URL	Project URL https://github.com/home1-oss/oss-lib-swagger
Source Code Management	Source Code Management https://github.com/home1-oss/oss-lib-swagger

License

MIT License

Filename	Size
oss-lib-swagger-1.0.8.OSS.pom	1 KB
oss-lib-swagger-1.0.8.OSS-site.xml	1 KB
Browse

oss-lib-swagger

Indroduction

通过引入oss-lib-swagger自动生成RESTful的api的接口文档,出于安全的考虑生成环境(production)暂不生成api文档。

使用方式

直接在spring boot工程中添加依赖,在非production发布时会生成对应的文档。

添加依赖
部署应用
访问swagger-ui: http://127.0.0.1:8080:8080/swagger-ui.html 接口说明文档 swagger-ui交互请求结果
访问api-docs: http://127.0.0.1:8080:8080/v2/api-docs api-docks swagger.ed插件示意图

依赖

    <dependency>
        <groupId>cn.home1</groupId>
        <artifactId>oss-lib-swagger-spring-boot-${spring-boot.version}</artifactId>
    </dependency>

application.yml:

springfox.documentation.swagger.v1.path: '/api-docs'
springfox.documentation.swagger.v2.path: '/v2/api-docs'

NOTES:如果项目开启了自定义的SpringMVC，即@EnableWebMvc，需要配置指定swagger-ui.html的路径，如下：

@Configuration
@EnableWebMvc
public class WebMvcConfiguration extends WebMvcConfigurerAdapter {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
        super.addResourceHandlers(registry);
    }

}