Swagger UI

Swagger是个前后端协作的利器，解析代码里的注解生成JSON文件，通过Swagger UI生成网页版的接口文档，可以在上面做简单的接口调试 。

实现原理：

因为Swagger-ui读取的数据来源于/v2/api-docs，并且返回的是json数据。 

所以只要自己写一个页面去解析json数据，并展现就可以实现自定义swagger的UI界面了 

如何使用Swagger

1、引入jar包

首首先需要在你的 pom.xml 中引入swagger的包

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
</dependency>

2.启用swagger

启用swagger ,创建SwaggerConfig文件，内容如下，

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket ProductApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .genericModelSubstitutes(DeferredResult.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(false)
                .pathMapping("/")
                .select()
                .build()
                .apiInfo(productApiInfo());
    }

    private ApiInfo productApiInfo() {
        ApiInfo apiInfo = new ApiInfo("XXX系统数据接口文档",
                "文档描述。。。",
                "1.0.0",
                "API TERMS URL",
                "联系人邮箱",
                "license",
                "license url");
        return apiInfo;
    }
}

3.添加swagger注解

常用的swagger注解 
Api 
ApiModel 
ApiModelProperty 
ApiOperation 
ApiParam 
ApiResponse 
ApiResponses 
ResponseHeader 
具体可以参考swagger官方注解文档：http://docs.swagger.io/swagger-core/apidocs/index.html

4.添加自定义UI界面

有两种方式 
1.可以在项目的基础上新增一个servlet ,指向对应的html文件 
html文件里再去解析json，并渲染UI

2.新建一个项目，用webjars将前端资源打成jar包，再供其他项目使用 

仅供个人学习参考/导航指引使用，具体请以第三方网站说明为准，本站不提供任何专业建议。如果地址失效或描述有误，请联系站长反馈～感谢您的理解与支持！

链接: https://web.fly63.com/nav/910