問題タブ [mson]

仕様の新しい Attributes セクションと DataStructures セクションを使用して、API ブループリントでエンドポイントを文書化しようとしています。

私のリクエストペイロードは次のようになります。

私の応答ペイロードは次のようになります。

次の API ブループリント マークダウンを試しました。

これを Apiary で見ると、これは有効な API ブループリント ドキュメントであることがわかりますが、JSON がリクエストとレスポンスをどのようにプレビューするかはわかりません。このような構造は、API ブループリントで表現でき、Apiary で適切にレンダリングできますか?

私は現在、そのような API の設計図を持っていますが、適切なレンダリングを実現できません。

私の質問は次のとおりです。

• 主に、リクエストとレスポンスのペイロードのテーブルが必要です。私はレイアウトを実現したいと思います: "Response" -> 応答のペイロードとして来る json オブジェクトのフィールドを持つテーブル。「+ Attributes」を入力すると表示されましたが (設計図を参照)、ペイロードとして json オブジェクトがある場合、これが状況を説明する正しい方法であるかどうかはわかりません。たぶん、他のキーワードを使用する必要がありますか？

• 「+ SampleProperties(SamplePropertiesDTO)」と記述されたフィールドでテーブルをレンダリングすると、オブジェクト型の SampleProperties としてテーブルの行としてレンダリングされたページに表示され、SamplePropertiesDTO の内容はレンダリングされたページのどこにもありません。ただし、すべてのデータ構造が配置されている場所など、インラインまたはドキュメントの別のセクションとして存在する必要があります。

• 可能であれば、データ構造オブジェクトのテーブルを個別に明示的に表示したいと考えています。現在、データ構造セクションは画面に表示されていません。どうすればそれができますか？

API ブループリントと Apiary で使用するために、MSON 形式のオブジェクトでネストされた配列を作成したいと考えています。コードは正しいように見えますが、Apiary でレンダリングすると、期待される JSON が得られません。

作成したい例：ナビゲーションには複数のカテゴリがあります。各カテゴリには、複数のサブカテゴリを使用できます。各カテゴリとサブカテゴリには名前があります。

このために作成した MSON:

JSONで期待する出力：

私がApiaryで得た出力

API ブループリント、特に MSON の新しいデータ構造構文の可能性を調査しています。パターン（正規表現）のようなものを添付または指定することは可能ですか？このトピックについては何も見つかりませんでした。

Apiary.io の API Blueprint を活用して、HAL+JSON を使用した新しい API を開発しています。ブループリント自体の応答で JSON を使用しています。代わりに MSON の使用への移行をテストしていますが、配列オブジェクトに問題があります。

これが API ブループリント コードです。curiesone を含む配列 (下部に向かって)を除いて、すべてがうまく機能しますobject。

そのcuries配列に対して、JSON の API ブループリント出力は以下を返します。

期待されるのは、次のような JSON です。

MSON 仕様からわかる限り、curies配列とオブジェクトの構文は正しいです。

同様の MSON 調査を行ったことのある方からのフィードバックをお待ちしております。

パラメータセクションの私の想定される解決策は

しかし、セマンティックエラーで失敗しました:

パラメータ フィールドの例の値 [firstField, secondField] は、期待される値のリストにありません

データ構造の記述にプリミティブ型を使用したい。そのようです：

そして、出力は次のとおりです。

なので説明不足。私は別の場所に説明を入れようとしました。私はたくさんのことをしました（それらについては話したくありません）。また、次のように列挙値に情報を追加しようとしました:

この問題が MSON 構文と Aglio ジェネレーターのどちらを扱っているかはわかりません。