Spring Boot 2.x（十二）：Swagger2的正确玩法

Ilikewhite 发布于2019-08-19 10:22 / 2031人阅读

摘要：简介简单的来说，的诞生就是为了解决前后端开发人员进行交流的时候文档难以维护的痛点，它可以和我们的程序完美的结合在一起，并且可以与我们的另一开发利器来配合使用。

Swagger2简介

简单的来说，Swagger2的诞生就是为了解决前后端开发人员进行交流的时候API文档难以维护的痛点，它可以和我们的Java程序完美的结合在一起，并且可以与我们的另一开发利器Spring Boot来配合使用。

开始使用 第一步：导入POM文件

         
            io.springfox
            springfox-swagger2
            2.9.2
         
        
        
        
            com.github.xiaoymin
            swagger-bootstrap-ui
            1.9.0

#### 第二步：添加配置类

我们需要新增一个Swagger2Config 的配置类：

/**
 *    Swagger2 配置类
 * @author vi    
 * @since 2019/3/6 8:31 PM
 */
@Configuration
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("indi.viyoung.viboot.*"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("viboot-swagger2")    //标题
                .description("Restful-API-Doc")    //描述
                .termsOfServiceUrl("https://www.cnblogs.com/viyoung") //这里配置的是服务网站，我写的是我的博客园站点~欢迎关注~
                .contact(new Contact("Vi的技术博客", "https://www.cnblogs.com/viyoung", "18530069930@163.com")) // 三个参数依次是姓名，个人网站，邮箱
                .version("1.0") //版本
                .build();
    }
}

第三步：在启动类中添加配置

注意一定要记得添加@EnableSwagger2注解

/**
 * @author vi
 * @since 2019/3/6 6:35 PM
 */
@SpringBootApplication
@ComponentScan(value = "indi.viyoung.viboot.*")
@MapperScan(value = "indi.viyoung.viboot.swagger2.mapper")
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class ViBootSwaggerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ViBootSwaggerApplication.class, args);
    }
}

第四步：通过注解来完成API文档

1. @Api

注解名称	注解属性	作用域	属性作用
@Api	tags	类	说明该类的作用
	value	类	说明该类的作用

举个

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/75909.html

SpringBoot 2.X Kotlin与Swagger2生成API文档

摘要：再通过函数创建的之后，用来创建该的基本信息这些基本信息会展现在文档页面中。函数返回一个实例用来控制哪些接口暴露给来展现，本例采用指定扫描的包路径来定义，会扫描该包下所有定义的，并产生文档内容除了被指定的请求。 showImg(http://download.qfeoo.com/kotlin_springboot_logo.png); 这里有个地方需要注意，在测试WebFlux集成Swa...

cyqian 2019-08-16 16:38 评论0 收藏0
Java | Spring Boot Swagger2 集成REST ful API 生成接口文档

摘要：集成生成接口文档原文简介由于的特性，用来开发变得非常容易，并且结合来自动生成文档变得方便快捷。使用生成，我们可以得到交互式文档。听过与的结合，生成更加完备的文档。接下来将基于与搭建完整的文档系统。 Spring Boot Swagger2 集成REST ful API 生成接口文档原文简介由于Spring Boot 的特性，用来开发 REST ful 变得非常容易，并且结合 Sw...

joyvw 2019-08-16 10:56 评论0 收藏0
Gradle环境下导出Swagger为PDF

摘要：没错，不支持，从导出的文档也可以看到，部分中文无法显示，目前我也尚未找到是否有配置可以实现这个功能。相对前面的方式，使用起来更加简单，也可以修改配置输出中文。更多精彩博文，欢迎访问我的个人博客说明我个人是一直使用Swagger作为接口文档的说明的。但是由于在一些情况下，接口文档说明需要以文件的形式交付出去，如果再重新写一份文档难免有些麻烦。于是在网上看到了Swagger2Mar...

OnlyMyRailgun 2019-08-16 18:23 评论0 收藏0
Spring Boot中使用Swagger2构建API文档

摘要：使用生成，我们可以得到交互式文档，自动生成代码的以及的发现特性等。方法指定扫描的包会生成文档默认是显示所有接口可以用注解标识该接口不显示。程序员都很希望别人能写技术文档，自己却很不愿意写文档。因为接口数量繁多,并且充满业务细节,写文档需要花大量的时间去处理格式排版,代码修改后还需要同步修改文档,经常因为项目时间紧等原因导致文档滞后于代码，接口调用方的抱怨声不绝于耳。而程序员是最擅长偷...

taohonghui 2019-08-15 11:09 评论0 收藏0
SpringBoot 实战 (五) | 集成 Swagger2 构建强大的 RESTful API

摘要：今天给你们带来集成的教程。接口返回结果不明确。这些痛点在前后端分离的大型项目上显得尤为烦躁。接口返回结果非常明确，包括数据类型，状态码，错误信息等。生成后的文件依赖如下这里使用的是的版本。另外，关注之后在发送可领取免费学习资料。微信公众号：一个优秀的废人如有问题或建议，请后台留言，我会尽力解决你的问题。前言快过年了，不知道你们啥时候放年假，忙不忙。反正我是挺闲的，所以有时间写 b...

Rindia 2019-08-16 15:12 评论0 收藏0