API文档工具swagger

一、简介

        Swagger是全球最大的OpenAPI规范（OAS）API开发工具框架，支持从设计和文档到测试和部署的整个API生命周期的开发。至于如何使用？ 这里用spring boot的restful开发做讲解，IDE使用intelli idea。

1、优点

区别传统文档的两个优点：

1. 生成在线文档动态更新 （文档根据当前的接口生成） 避免了文档版本多，代码文档不同步等问题。
2. 在线restful形式的接口      边看文档的同时测试接口，取代了了传统的postman、curl等，那是相当的方便。

2、API

   API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。

3、API和swagger的关系

        Swagger是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。Swagger™的目标是为REST APIs 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。当服务通过Swagger定义，消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口，Swagger去掉了调用服务时的很多猜测。

二、组成部分

Swagger包括库、编辑器、代码生成器等很多部分。

1、

2、

3、

4、

三、开发使用

四、文档编写规范建议

五、类似工具及优缺点

1、apizza

2、YApi

3、RAP 2

4、eolinker

本文来自互联网用户投稿，文章观点仅代表作者本人，不代表本站立场，不承担相关法律责任。如若转载，请注明出处。 如若内容造成侵权/违法违规/事实不符，请点击【内容举报】进行投诉反馈！