API Blueprint vs Swagger的独特目的是什么？

Question

我正在尝试以云原生方式开发应用程序.我正在尝试API应用程序的第一个设计.

我应该使用哪种API文档工具？哪一个更适合API第一合同？而哪一个适合哪里？

Answer 1

我会说这两种格式都适合API第一种方法,所以这是一个品味问题(降价与基于yaml/json)或工具限制.

您可以在https://help.apiary.io/api_101/choosing-format/上阅读简要摘要.

这两种格式都是开源的,并且围绕它们构建了很好的社区和工具.

• Swagger是YAML(或JSON)格式,重点易于解析,并具有扩展和集成的广泛选项.
• API Blueprint的语法接近Markdown,MSON以及对所有Apiary工具和开源工具的全面支持.

两者都应该允许您使用设计优先方法描述一组广泛的API体系结构.Swagger附带了从代码生成描述的工具.API Blueprint语法可以更轻松地描述超媒体/ REST API.

如果您不熟悉API描述世界,我们建议您从API蓝图开始.