OpenAPI

OpenAPI，有时也称为Swagger，是一种用于定义RESTful API的规范。 OpenAPI规范使用JSON或YAML格式来描述API的结构和功能，包括API的路径、参数、请求和响应等。

回到项目开发，只要是提供RESTful API的服务，都应该提供OpenAPI规范，这样可以帮助开发者更好地理解API的功能和使用方式。 OpenAPI规范还可以用于自动生成API文档、客户端代码、服务端代码等，如Swagger UI, OpenAPI Generator等等，可以帮助团队更好地协作和开发。

就目前来说，基本上大多数Web Framework都提供了OpenAPI规范的支持，IDE和Editor都有对OpenAPI的支持，因此我们建议在项目中使用OpenAPI规范。

OpenAPI & Friends

• Swagger: Simplify your API development with our open-source and professional tools
• AsyncAPI: Building the future of Event-Driven Architectures (EDA)
• OpenAPI Generator: Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents