Я работал с форматом 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)
...
Это явно не работает, и я не могу найти ничего, что относится к тому, что я хочу сделать в документах. Может быть, я пропустил это.
Так как ты это делаешь? Является ли это возможным?
Спасибо!
