OpenAPI
OpenAPI是描述一套REST API每个端点、参数和响应的机器可读schema,可据此生成客户端代码。
详解
这个API会发布一份OpenAPI 3.1文档,以及一份llms.txt索引,SDK生成器、Postman集合或者代理框架因此不必先读一堆散文,就能理解它的接口面。它是请求结构和状态码的事实来源。行为变更会在上线前写进changelog,所以生成的客户端可以主动重新生成,而不是等着发现它坏了。
又称
- swagger
- api schema
OpenAPI是描述一套REST API每个端点、参数和响应的机器可读schema,可据此生成客户端代码。
这个API会发布一份OpenAPI 3.1文档,以及一份llms.txt索引,SDK生成器、Postman集合或者代理框架因此不必先读一堆散文,就能理解它的接口面。它是请求结构和状态码的事实来源。行为变更会在上线前写进changelog,所以生成的客户端可以主动重新生成,而不是等着发现它坏了。