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

What is distinctive purpose of API Blueprint vs Swagger?

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

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

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

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

Both formats are open-sourced and have great community and tooling built around them.

  • Swagger is YAML (or JSON) format, with focus to be easy to parse and has wide options of extensions and integrations.
  • API Blueprint comes with syntax close to Markdown, MSON and full support of all Apiary tooling and open-source tooling.

Both should allow you to describe a broad set of API architectures with design-first approach. Swagger comes with tools to generate a description from code. API Blueprint syntax makes it easier to describe hypermedia/REST APIs.

If you are new to API Description world, we recommend to start with API Blueprint.