架构师之路 — API 经济 — Swagger & OpenAPI Specification

本文介绍了OpenAPI Specification(OAS),它是一种RESTful API的描述格式,用于定义API的端点、操作、参数等。Swagger是一系列基于OAS的工具,包括Swagger Hub、Inspector、Editor、Codegen和UI。文章还讨论了如何编写OpenAPI规范文件,涵盖根对象、数据类型、请求API的定义,并提供了官方示例和参考资料。
摘要由CSDN通过智能技术生成

目录

OpenAPI Specification

Swagger Specification 是一种 API Specification(API 规范),2015 年,SmartBear Software 将 Swagger Specification 捐赠给 Linux Foundation,并改称为 OpenAPI Specification,简称(OAS)。SmartBearSoftware 也作为 OpenAPI Initiative(OAI)的创始成员,该机构以开放和透明的方式管理 OAS 的发展。

OpenAPI Specification 本质上是一种 RESTful API 的 API Description Format(描述格式),允许用户用于描述整个 API。OpenAPI 规范可以用 YAML 或 JSON 编写,包括:

  • 每个 API 的可用端点(e.g. /users)和操作(e.g. GET /users,POST /users)。
  • 操作参数每个操作的输入和输出。
  • 认证方式。<
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

范桂飓

文章对您有帮助就请一键三连:)

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值