OpenAPI设计优先API参考

时间:2017-10-30 15:39:57

标签: swagger swagger-node

我正在尝试使用OpenAPI格式(v2)记录REST API引用。 我希望它是" design-first",这意味着我的swagger规范将是API实现的合同。

我尝试了很多模块和解决方案,例如 swagger-node (关于文件夹结构和实现过于注意), swaggerize-express 迫使我使用express等。我还尝试了 generator-openapi-回购,但它似乎过时了,不再维护。

用于记录REST API参考的任何解决方案,首先是设计,而不是将文档与实际实现相结合?

1 个答案:

答案 0 :(得分:0)

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

npm install -g swagger

swagger project create my-app

swagger project edit

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

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