swagger2实战

最新推荐文章于 2024-07-04 09:05:13 发布

卡拉汪汪汪

最新推荐文章于 2024-07-04 09:05:13 发布

阅读量2.4k

点赞数

分类专栏： java 文章标签： swagger2 javaapi java-swagger2 api管理 javaSDK发布

本文链接：https://blog.csdn.net/qq_26409257/article/details/81539136

版权

本文介绍了如何使用Swagger2为Java服务生成在线和离线API文档。通过注解配置，Swagger2能自动生成接口文档，并通过swagger-ui提供测试功能。此外，还展示了如何利用swagger2markup将接口数据转换为HTML、PDF等离线文档。

摘要由CSDN通过智能技术生成

swagger2实战

一、概论

服务器提供的java服务越来越多，每个服务提供的接口的文档化和自动化可以省略很多不必要的功夫。swagger2提供了这个能力。

二、在线api

swagger2通过在各Controller控制层加注解的方式，获取对每个接口的输入输出格式和http请求格式，整理成接口，前端 swagger-ui解析该接口数据并展示，还提供了对接口的测试功能。

1) 包依赖

根据不同jdk可适当降低版本。

<!--swagger2-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>

2) swaggerConfig类配置

注册进spring，并获取springMVC的接口信息。

@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurerAdapter {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("v1")
                .apiInfo(apiInfo())
                .useDefaultResponseMessages(false)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.ant("/api/v1/**"))
                .build()
                .enableUrlTemplating(false);
    }
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("使用Swagger2构建RESTful APIs")
                .description("本人期待更多的技术碰撞！请关注：wangjian090@126.com")
                .termsOfServiceUrl("wangjian090@126.com")
                .contact("wangjian")
                .version("1.0")
                .build();
    }
    @Override
    public voi