問題タブ [apiblueprint]

API ブループリントをスキーマと一緒に使用したいと考えています。たとえば、リソースへの PUT がペイロードでアカウントを受け入れ、同じリソースの GET がアカウント ペイロードを返すように指定したいとします。そのため、アカウントが GET および PUT で使用されることを指定する必要があり、アカウント自体を指定する必要があります。どこで指定すればいいのかわからないのですが、標準的な方法は何ですか? 残念ながら、私は例でそれを見つけることができませんでした.

あるリクエストに対するすべてのレスポンスに説明を指定することはできますか? リクエストがあるとします

そして2つの応答

私が望むのは、ここのような説明を指定することです (+ Response行のすぐ下のコメントに注意してください):

出来ますか？

お時間をいただきありがとうございます。青写真の養蜂場に記録したい POST リクエストがあります。ヘッダーは次のようなものです。

テキスト/html

_method:POST

データ[ユーザー][ユーザー名]:

データ[ユーザー][パスワード]:

データ[ユーザー][記憶]:0

http://d.pr/i/uRFx

私はこのようなものを持っていますが、それを終了する方法がわかりません:

何か案が？ありがとう！

ブループリントを構築しようとしている既存の API が 1 つあります。この API では、特定のリクエスト ボディが URI エンコードされた JSON である必要があります。

ボディを「このように、しかしエンコードされた」と指定する方法はありますか?

既存の (単なるテキスト) ドキュメントは、JSON を表示するだけで、送信前にエンコードするための気の利いたリマインダーも表示されます。

しかし、ブループリント (特に apiary.io のブループリント) を使用すると、実際のボディを表示する必要があります。これは完全に読めません:

しかし、ブループリントで読み取り可能なテキストを指定すると失敗します (パラメーター エラーが返されます)。

本当の問題点は、Apiary を実サーバーと通信させたときです。読み取り可能な要求は失敗し (エンコードされていないため)、読み取り不能な要求は成功します (必要に応じてエンコードされているため)。

Railsがパラメーターをグループ化する方法である、パラメーター名に角括弧を含めることができるかどうか疑問に思っていました。例えば：

現在、角かっこを含めると、パラメーターはレンダリングされません。

ありがとう！

「モデル」機能は、重複を減らすことを目的としているようです。リソースのさまざまなメソッドへのリクエストとレスポンスを指定する場合、同じボディが複数回指定されることがよくあります。そのため、「モデル」を定義してから、さまざまなリクエストおよびレスポンスの「ペイロード」セクション内でそれを「参照」できます。

だから私は次のようにモデルを定義しました：

その後、さまざまな場所で参照できます。

これはうまくいきます。出力には、相互参照の代わりにモデル本体全体が含まれます。

ただし、この参照をリクエストまたはレスポンス ヘッダーと組み合わせる方法がわかりません。

これらの行に沿ってさまざまな形式を試しました：

また

運がない。

これを行う方法はありますか？