Mongoosej.Blog.Programing.Framework.Utils.OpenAPI
:::info
版权声明:本文为语雀博主「mongoosej」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://www.yuque.com/mongoosej/blog/openapi
:::
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. OpenAPI 规范(OAS),是定义一个标准的、与具体编程语言无关的RESTful API的规范。OpenAPI 规范使得人类和计算机都能在“不接触任何程序源代码和文档、不监控网络通信”的情况下理解一个服务的作用。如果您在定义您的 API 时做的很好,那么使用 API 的人就能非常轻松地理解您提供的 API 并与之交互了。 An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases. 如果您遵循 OpenAPI 规范来定义您的 API,那么您就可以用文档生成工具来展示您的 API,用代码生成工具来自动生成各种编程语言的服务器端和客户端的代码,用自动测试工具进行测试等等。
一个实用的OpenAPI层次结构查看在线工具OpenAPI Map
The OpenAPI Map (fka. OpenAPI Specification Visual Document) aims to help you find your way in the OpenAPI Specification (fka. Swagger Specification) documentation. Note that it is not made to render an OpenAPI document. OpenAPI 地图(fka. OpenAPI Specification Visual Document)旨在帮助您在 OpenAPI 规范(fka. Swagger Specification)文档中找到自己的方式。请注意,它不是用来呈现 OpenAPI 文档的。 It has been created by Arnaud Lauret, the API Handyman. 它由 API Handyman Arnaud Lauret 创建。
https://openapi-map.apihandyman.io/
https://github.com/arno-di-loreto/openapi-map
http://apihandyman.io/