問題タブ [apiblueprint]

API ブループリントを試してみたところ、よくわからないことがいくつかありました。

1. POST 本文のパラメーターを文書化するにはどうすればよいですか?

ありますが+ Parameters、クエリパラメーターを文書化するだけです。POST API を記述したい場合、POST パラメーター (application/x-www-form-urlencoded) を文書化することはできません。同じことが JSON にも当てはまります (#3 を参照)。

2. 応答に説明を追加する方法はありますか?

私は試した

しかし、これは本文のレスポンスとしてテキストを追加するだけです。

3. 回答のさまざまなフィールドについて説明してください

JSON を返す場合は、各フィールドを個別に、そのタイプと目的について説明したいと思います。それを行う方法はありますか？

ありがとう！

次のようなマルチパートリクエストを文書化したい:

このcurl同じリクエストを再現するには、次のようにします。

Apiary で定義された API コントラクトがあり、リソース モデル構文を使用してペイロードの再利用を有効にしています。

ただし、Apiary によってレンダリングされたドキュメントにはモデル名のみが表示されます (たとえば、Response 200 は [Foo][] を返します)。Foo とは何かについての詳細や、Foo モデルの属性を表示するためのリンクはありません。

モデルが与えられた場合、レンダリングされたドキュメントでそのモデルの属性を確認するにはどうすればよいですか?

更新
契約の関連部分は以下のとおりです。

私の API は完全なホスト URL を返します。Apiary では、すべてのユーザーがモック サーバー用の独自のプライベート URL を持っています。

この URL を応答本文で使用する方法はありますか?

今のところ、応答本文で独自の URL を使用しています。