自动生成API文档

大话swift

发布于 2019-07-03 17:01:33

1.8K0

发布于 2019-07-03 17:01:33

文章被收录于专栏：大话swift

对于我们App开发人员来说，API那就是生命中的血液，每日都在在我们的App中穿插流淌，但是对于API的数据测试和预览管理那是十分头疼的一件事情，那么问题来了？今天就来个干货帮咱们完成这个东东……下次服务端的童靴再不好好写API的时候就把这个砸他脸就成……

导入依赖

 <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>

Application同级目录下创建Swagger服务结构如下：

文件内部代码如下

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestfullApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xsk"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {

        return new ApiInfoBuilder()
                .title("Swagger2 ")
                .description("使用Swagger2做API预览")
                .termsOfServiceUrl("http://www.baidu.com")
                .contact("lylapp@163.com")
                .version("0.0.1")
                .build();
    }
}

如上代码所示，通过@Configuration注解，让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2。

帮助文档查看 swagger

本文参与腾讯云自媒体同步曝光计划，分享自微信公众号。

原始发表：2019-06-20，如有侵权请联系 cloudcommunity@tencent.com 删除

api