什么是OpenAPI?

OpenAPI规范(以前称为Swagger规范)是REST API的API描述格式。 OpenAPI文件允许您描述整个API,包括:

  • 每个端点上的可用端点(/users)和操作(GET /users,POST /users)
  • 操作参数每个操作的输入和输出
  • 认证方法
  • 联系信息,许可证,使用条款和其他信息。
  • API规范可以用YAML或JSON编写。该格式对人和机器都很容易学习和阅读。

完整的OpenAPI规范可以在GitHub上找到:
OpenAPI 3.0规范

Swagger是什么?

Swagger是一套围绕OpenAPI规范构建的开源工具,可以帮助您设计,构建,编写和使用REST API。

主要的Swagger工具包括:

  • Swagger编辑器 - 基于浏览器的编辑器,您可以在其中编写Open
  • API规范。Swagger UI - 将OpenAPI规范呈现为交互式API文档。S
  • wagger Codegen - 根据OpenAPI规范生成服务器存根和客户端库。

为什么要使用OpenAPI?
API描述其自身结构的能力是OpenAPI中所有迷人的根源。一旦编写完成,OpenAPI规范和Swagger工具可以以各种方式进一步推动您的API开发:

设计优先用户:

  • 使用Swagger Codegen为您的API生成服务器存根。剩下的唯一事情就是实现服务器逻辑 - 而且你的API已经准备好了!
  • 使用Swagger Codegen以超过40种语言为您的API生成客户端库。
  • 使用Swagger UI生成交互式API文档,让用户直接在浏览器中尝试API调用。
  • 使用该规范将API相关工具连接到您的API。例如,将规范导入到SoapUI来为您的API创建自动化测试。
    查看与Swagger集成的开源和商业工具。
 
转载请保留页面地址:https://www.breakyizhan.com/swagger/2806.html
扫描二维码添加微信 
  • ,每次淘宝领取淘宝优惠券,淘宝购物更优惠。现在添加微信,还可以领取机械键盘50元优惠券!添加微信后回复机械键盘即可领取!
    支持我们,就用微信淘宝!