API蓝图对Swagger的独特用途是什么？

Question

我正在尝试以云本地方式开发应用程序。我正在尝试让API首先设计我的应用程序。

我应该使用哪个API文档工具？哪一个更适合API第一批合同？更确切地说哪一种适合在哪里？

Answer 1

我认为这两种格式都适合于API第一种方法，所以这是一个品味问题(基于标签和yaml/json )或工具限制。

您可以在101/choosing-format/上阅读一个简短的摘要。

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

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

两者都应该允许您用设计优先的方法描述一组广泛的API体系结构。Swagger提供了从代码生成描述的工具。API蓝图语法使描述超媒体/REST变得更加容易。

如果您是API描述世界的新手，我们建议从API蓝图开始。