SpringCloud Alibaba微服务实战十一 - Swagger接口文档聚合

导读：在SpringCloud体系架构中，我们需要的每个服务都需要对外输出接口文档，本篇内容主要是给我们的微服务配上Swagger的接口文档，并在网关层完成接口聚合。

Swagger2简介

在当下很多项目都会采用前后端分离的模式，前端和后端的工作由不同的开发人员完成。在这种开发模式下，我们需要维护一份及时更新且完整的Rest API接口文档。传统意义上的文档都是后端人员在开发相关接口后手动更新到接口文档上，但是这种方式很难保证文档的及时性，而且由于一些原因后端开发人员可能会忘记更新，这样就会导致随着开发的进行接口文档会失去他本身的参考意义，反而会增加沟通成本。而 Swagger 给我们提供了一个全新的维护 API 文档的方式，他有以下几个有点：

• 只需要后端开发人员给接口加上几个注解，Swagger就可以根据代码自动生成API文档，节省编写接口文档的工作量，而且对接口修改时只需要修改相应的注解，能保证接口的及时性；
• SwaggerUI展现出来的是一份可交互式的API文档，我们可以直接在接口页面对功能测试，省去了大量接口联调的时间；

Swagger2有以下几个常见注解，大家在使用过程中会经常用到。

@Api

此注解可以用来标记