Swagger OpenAPI设计第一个API参考

Swagger OpenAPI设计第一个API参考,swagger,swagger-node,Swagger,Swagger Node,我正在尝试使用OpenAPI格式(v2)记录RESTAPI引用。 我希望它是“设计优先”,这意味着我的招摇过市规范将是API实现的契约 我尝试过许多模块和解决方案,例如,swagger node(对文件夹结构和实现过于挑剔),swaggerize express,这迫使我使用express,等等。我还尝试了一个生成器openapi repo,但它似乎过时了,不再维护 是否有任何解决方案可以记录REST API参考,先设计,不将文档与实际实现耦合?您可以作为本地编辑器使用。使用这些命令,运行swa

我正在尝试使用OpenAPI格式(v2)记录RESTAPI引用。 我希望它是“设计优先”,这意味着我的招摇过市规范将是API实现的契约

我尝试过许多模块和解决方案,例如,swagger node(对文件夹结构和实现过于挑剔),swaggerize express,这迫使我使用express,等等。我还尝试了一个生成器openapi repo,但它似乎过时了,不再维护

是否有任何解决方案可以记录REST API参考,先设计,不将文档与实际实现耦合?

您可以作为本地编辑器使用。使用这些命令,运行swagger编辑器并编写您的swagger规范:

npm安装-g-swagger

swagger项目创建我的应用程序

swagger项目编辑

设计完成后,存储在
api/swagger/
中的
swagger.yaml
文件可用于任何实现

如果您正在搜索在线编辑器,检查这些工具可能会有所帮助

  • 简单编辑器:
  • 协作编辑器(提供免费和付费版本):
您可以作为本地编辑器使用。使用这些命令,运行swagger编辑器并编写您的swagger规范:

npm安装-g-swagger

swagger项目创建我的应用程序

swagger项目编辑

设计完成后,存储在
api/swagger/
中的
swagger.yaml
文件可用于任何实现

如果您正在搜索在线编辑器,检查这些工具可能会有所帮助

  • 简单编辑器:
  • 协作编辑器(提供免费和付费版本):