在API Blueprint / MSON中引用已定义数据结构内的属性

时间:2017-12-16 19:05:16

标签: apiblueprint mson

我一直在使用API​​ Blueprint格式来设计API,并且使用它有很多乐趣。当我宣布我的数据结构时,我遇到了代码重用或模型重用问题。

根据文档声明响应时,必须这样做:

例如:

+ Request 200 (application/json)

然而,当多个人处理文档时,我不想指示他们使用什么返回代码,因为我们已经定义了这些代码,并且他们的数字会让人忘记它们。所以为了避免不得不来回,我改为使用/引用其中一个属性的想法:

# Data Structures

## HttpCode (object)
+ success: 200 - Request processed successfully
+ not_found: 404 - Content requested not found
+ forbidden: 403 - Access to content is forbidden

我会这样引用它:

+ Response (HttpCode.success) (application/json)
...

它显然不起作用,我找不到任何与我想要在文档中做什么相关的内容。也许我错过了它。

那你怎么做的?有可能吗?

谢谢!

1 个答案:

答案 0 :(得分:1)

这是不可能的。他们在GitHub的代表关闭了我的问题。 https://github.com/apiaryio/api-blueprint/issues/411