REST：发布数据模型的最佳实践

Question

发布 REST 的数据模型有哪些最佳实践API？

我想向 REST 添加一个方法 API，其中 returns 包含 API 提供的每个方法的 Avro 模式描述 (.avsc) 的纯文本。

或者提供有关 REST 返回的数据结构的信息的更好方法是什么 API？

Answer 1

您可以根据自己的喜好使用 Swagger (http://swagger.io/), Blue Print (https://github.com/apiaryio/api-blueprint) or RAML (http://raml.org/)。