api文档在线自动生成工具Swagger推荐（含Spring Cloud集成版）

咖啡和茶还有书 06-23 3389

前言：

而今姐妹们对“apache在线工具”都比较着重，看官们都需要分析一些“apache在线工具”的相关文章。那么小编同时在网摘上网罗了一些对于“apache在线工具””的相关文章，希望小伙伴们能喜欢，大家一起来了解一下吧！

一、Swagger是什么

二、Swagger功能演示

三、Swagger 与Spring Cloud 集成

Swagger是什么

Swagger 是一款线自动生成+测试功能插件，基于RESTFUL接口调动。

开发人员经常会遇到写接口文档的工作，一般都是word文档，带来书写麻烦、维护麻烦的问题，比如改了源代码忘了更新文档、解释不明确带来歧义、无法在线尝试等等。swagger就是为了解决这些问题而产生的。

Swagger是最受欢迎的REST APIs文档生成工具之一，主要有以下几个原因：

可以快速生成API调用接口，提供完整的接口输入输出参数说明，方便调用者调试。

可以方便与多平台集成

文件可以在许多不同的平台上从代码注释中自动生成。

Swagger 社区活跃，项目发展有保障。

Swagger 文档提供了一个方法，使我们可以用指定的 JSON 或者 YAML 摘要来描述你的 API，包括了比如 names、order 等 API 信息，也可以通过代码注释方式描述。本文以代码注释方式演示。

Swagger功能演示

1、代码逻辑

@api，用在类上，用于解释整个类。

@apioperation，用于方法上，value是概要介绍方法作用，notes是详细说明。

2、Swagger UI 展示

（api被调用执行结果在线展示）

Swagger 与Spring Cloud 集成

1、下载jar包

2、本地安装

cd spring-boot-starter-swagger2

mvn install

3、在spring-cloud的项目中，添加maven依赖

pom.xml

<groupId>com.github.ganity</groupId>

<artifactId>spring-boot-starter-swagger2</artifactId>

</dependency>

4、Spring Cloud 配置

application.yml or application.properties

swagger:

enable: true #if enable swagger

group: item #the api group name

title: item-title #the title

description: item description

version: v1.10

contact-name: ganily

base-package: video.lark.mall.item.service #the base package for RequestHandlerSelectors default all the package

license: Apache License Version 2.0

5、Spring Cloud 服务重启

访问 swagger ui 页面

结束

欢迎大家多交流，谢谢！