Я использую Apiary для издевательства над новым API.API Blueprint - использовать данные Strucutres в ответ, без атрибутов
Я пытаюсь избежать необходимости повторять все ответы JSON снова и снова. Если я сделаю это с помощью + Attributes(user)
, тогда он автоматически сгенерирует кучу блоков атрибутов на панели компьютера, что очень путает меня в голове (особенно когда у вас есть несколько ответов).
В результате документация выглядит лучше, если вы вручную выберете блоки запроса/ответа JSON.
Есть ли способ хранения объектов Request/Response в качестве структуры данных? Может быть, модель?
Я хотел бы быть в состоянии сделать что-то вроде этого:
## Users [/auth]
A user object contains the these attributes.
+ Attributes (user) <!-- I like this here -->
### Refresh a token for a user [POST /auth/refresh]
+ Request (application/json)
+ Headers
Authorization: Bearer jsonWebToken
+ Response 200 (application/json)
+ Body
{
"data": [
(user) <!-- I wish this was the user data structure as JSON -->
],
"meta": {
"access_token": "jsonWebToken",
"token_type": "Bearer",
"expires_in": 3600
}
}
# Data Structures
## user (object)
+ id: 123 (number)
+ email: [email protected]
Примечания: Объект user
длиной 30 атрибутов в реальной жизни.
Да, я был бы в порядке с использованием атрибутов, если он не сгенерировал блоки на панели машины (тот, что находится справа справа в синем). –
Возможно, вам захочется открыть проблему в самой Пасеке. Просто подключитесь к сайту со своей учетной записью и используйте внутренний чат, чтобы зарегистрировать проблему - мы постараемся позаботиться об этом. – Vincenzo