0
私はApiaryを使って新しいAPIを模擬しています。API Blueprint - アトリビュートのないレスポンスでData Strucutresを使用
私はすべてのJSON応答を繰り返し書き出す必要がないようにしようとしています。私が+ Attributes(user)
を使用してそれを行うと、機械パネルの属性ブロックが自動的に生成されます(特に複数の応答がある場合)。
JSONリクエスト/レスポンスブロックを手作業で書き出すと、結果として得られるドキュメントがより良く見えます。
リクエスト/レスポンスオブジェクトをデータ構造として保存する方法はありますか?おそらくモデルでしょうか?
私はこのような何かをできるようにしてみたい:
## 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個の属性の長さです。
はい機械パネル(青い右端にあるもの)にブロックが生成されない限り、属性を使用すると問題はありません。 –
その後、Apiary自体で問題を開くことができます。 アカウントでウェブサイトに接続し、内部チャットを使用して問題を提出するだけで対応します。 – Vincenzo