配置 Swagger 文档的自动生成

Swagger

Swagger 是一个开源工具。它围绕帮助开发人员设计、构建、记录和使用 RESTful API 的 OpenAPI 规范构建。它是 RESTful Web 服务最流行的 API 文档格式。它提供 JSON 和 UI 支持。JSON 可以作为机器可读的格式，Swagger-UI 用于可视化展示，人类只要浏览 API 文档就很容易理解。主要的 Swagger 工具有：

Swagger UI：它创建交互式 API 文档。
Swagger Editor：它是一个基于浏览器的编辑器，我们可以在其中编写 OpenAPI 规范。
Swagger Codegen：它生成服务器存根（API implementation stub），客户端库形成一个 OpenAPI 规范。

OpenAPI规范（以前称为 Swagger 规范）是 REST API 的 API 文档格式。一个开放的 API 文件允许我们描述我们的整个 API，包括：

可用端点 (/users)和每个端点上的操作(GET /users, POST /users)。
每个操作的操作参数。
身份验证方法。
联系方式、许可、使用期限等信息

让我们为我们的 RESTful 服务生成 Swagger 文档。

第一步：打开pom.xml并添加springfox-swagger2依赖。程序

<dependency>  <groupId>io.springfox</groupId>  <artifactId>springfox-swagger2</artifactId>  <version>2.9.2</version>
</dependency>

添加另一个依赖springfox-swagger-ui

<dependency>  <groupId>io.springfox</groupId>  <artifactId>springfox-swagger-ui</artifactId>  <version>2.9.2</version>
</dependency>

现在我们需要配置 Swagger。

第 2 步：创建一个名为SwaggerConfig.java的类并编写以下代码。

Docket：一个构建器，旨在成为 swagger-Spring MVC 框架的主要接口。Docket 为配置提供了合理的默认值和方便的方法。

package com.javatpoint.server.main;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;//Configuration
@Configuration
//Enable Swagger
@EnableSwagger2
public class SwaggerConfig {
//creating bean@Beanpublic Docket api() {return new Docket(DocumentationType.SWAGGER_2);}//bean- docket
//swagger 2
//All the paths
//all the APIs
}

第 3 步：运行应用程序。

第 4 步：打开浏览器并输入 URI http://localhost:8080/v2/api-docs

它以 JSON 格式显示完整的文档，如下图所示。它不容易阅读和理解。Swagger 已将其提供给其他系统，例如提供 API 网关、API 缓存、API 文档等功能的 API 管理工具。

如果我们想与客户共享 Web 服务的文档，我们可以共享这个 JSON 文件。

现在在浏览器中输入 URI http://localhost:8080/swagger-ui.html。它显示了我们创建的服务的文档。

我们还可以扩展服务以查看服务中存在哪些操作。在下图中，我们扩展了用户资源服务。

点击这里下载项目

配置 Swagger 文档的自动生成相关推荐

自动生成python接口文档_Django自动生成Swagger接口文档
Django自动生成Swagger接口文档 1. 前言当接口开发完成,紧接着需要编写接口文档.传统的接口文档通常都是使用Word或者一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次 ...
怎么用计算机做目录,word怎么生成目录,教您Word文档如何自动生成目录
word是我们常用的文字编辑器,学会一些word基本操作,使办公更加方便.我们平时写文章或写论文的时候为了方便,文章生成一个目录在查找的时候就很容易找到,如何生成目录呢?下面,小编给大家介绍Word文 ...
PDF文档一键自动生成目录和书签
在工作中经常会遇到编写文档的时候,当我们在word编写完文档后,一般可以自动生成一个目录.为了方便阅读和保护文档不被破坏,一般发送给别人的时候,需要把word文档转换成PDF格式.但是word文档 ...
python生成api文档_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
Word文档如何自动生成文献摘要？
一.启动"自动编写摘要"功能 Word 97/2000/XP/2003均支持此项功能,用Word打开需要编辑的论文后,在"工具"菜单选择"自动编写摘要 ...
word文档生成PDF文档时候自动生成书签方法
0 Preface/Foreword 在日常工作中,经常需要写技术文档,为了排版美观,一般会选择word,这样就可以生成目录. word文件可以很方便生产PDF文档,方便分享给同事. 在阅读PDF文档 ...
php自动生成word目录,word文档怎么自动生成目录章节
方法:1.单击"开始"菜单区域的文档样式选项,编辑标题样式:如标题1.标题2等等.2.单击"开始"-样式"-右下角的"扩展"按钮. ...
Word文档如何自动生成目录
前言进度进行到了软工文档,参考文档上的目录既正规又好看,让我忍不住想研究一下. 内容其实我个人觉得Word目录生成方式和CSDN的目录生成方式有很多相似之处,接下来咱们就看看具体步骤. 步骤一: ...
Word文档目录自动生成和页码设置
自动生成目录: 1.点开始> 设置标题类型> 引用>自动生成目录 2.目录:按住ctrl并单击可访问链接设置页码: 1.将光标移至目录页的最后一个字节点击 ...

配置 Swagger 文档的自动生成

Swagger

配置 Swagger 文档的自动生成相关推荐

最新文章

热门文章