《微服务分布式构架开发实战》第16章 接口文档管理

第16章　接口文档管理

16.1　  Dubbo中使用Swagger2

16.2　  Spring Cloud中使用Swagger2

分布式架构中的各个服务最终产出RESTful风格的API接口，提供给前端（iOS、Android、Web）或其他第三方程序调用，一份丰富完整的接口描述文档能够大大降低沟通成本。本章将介绍如何使用Swagger轻松且方便地管理接口文档。

Swagger由两部分组成。

• Swagger-Codegen：生成JSON格式的接口描述文档。

• Swagger-UI：提供界面解析接口描述文档。

Swagger 官网：https://swagger.io/

16.1　Dubbo中使用Swagger2

Swagger主要在Controller中描述接口信息，在Dubbo架构中所有的服务都将由网关模块调用Dubbo服务转为RESTful API，所以Swagger的整合也将在网关模块中进行。

① 在pom.xml文件中引入Swagger2依赖。

<dependency>
    <groupId>org.apache.maven</groupId>
    <artifactId>maven-model</artifactId>
    <version>3.5.0</version>
</dependency>


<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-sw