問題タブ [apiblueprint]

残りのサービスの API-Decumentation を書いているときに、応答として返される可能性のあるすべての値をリストしたいという問題に遭遇しました。

以下の場合、列挙の可能な値を含むことができるのは「状態」フィールドであり、どの状態が存在するかを合計したかったのです。

私は apiblueprint でそれを行うための簡単で良い方法を見つけることができませんでした. デフォルトでセクションを折りたたんで表示し、追加情報が必要なときにセクションを展開する方法はありますか?

これが私が持っているサンプルコードです:

パラメータセクションには「値」のようなものが必要ですが、ボディ部分にはボディセクションの状態を記述する必要があります。

構文とその仕組みを理解するために、ドキュメントの例に従っています。

だから私はこのmdファイルを作成します

aglio を実行すると見栄えの良い html が表示されますが、問題が 1 つあります。「{?limit}」は POST URL にも適用されます。これは本当に悪いことです。何時間も探して、これを回避する方法を理解できません。

私たちが構築している API を使用すると、ユーザーはさまざまなリクエスト ボディを提供できます。私がこれまでに見たり見つけたりしたことから、アクション/リソースごとに 1 つのリクエストしか提供できません。どういうわけか異なるリクエストボディを指定することは可能ですか?

私はそれを次のように試しました：

また、好きです：

文字列の配列 (つまり、オブジェクトではない) を返す REST サービスがあります。関連する Apiary のブループリント マークダウンは次のとおりです。

Apiary でモック サービスを実行すると動作しますが、Apiary トラフィック インスペクターで次のエラーが発生します。

これを機能させるためのトリック (マークダウンへの変更) はありますか、それとも Apiary のバグですか?

Cloud Endpoint (Java) から生成されたファイルから、読み取り可能な形式で API ドキュメントを生成する効率的な方法を探しています。生成されるファイルは次のいずれかです。 - my_api.api - my_api*.discovery

次のようなもの: - https://github.com/kevinrenskers/raml2html#example-output

Swagger、API ブループリント、および RAML はすべて適切なオプションですが、エンドポイントで生成された API 記述子ファイルにはうまく適応していないようです。

どのような方法を使用していますか?

を使用してリソースを作成し、それが応答本文でPOST /resourceを生成し、それを使用して を使用してリソースを取得するとします。ididGET /resource/{id}

これら 2 つのリクエストを同じ API ブループリント グループに入れるにはどうすればよいですか?

POST /resource/{id}どうやらグループにはエンドポイントが 1 つしかないため、この時点では ID さえ持っていないため、true ではないリソースを作成するように見えます。

例を見ましたが、特定のリソースを作成および取得する例が見つかりませんでした。私はこれを間違った方法でやっていますか？