我一直在使用 API 蓝图格式来设计 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)
...
它显然不起作用,我在文档中找不到与我想要做的事情有关的任何内容。也许我错过了。
你是怎么做到的?可能吗?
谢谢!