問題タブ [apiblueprint]

API ブループリントで、特定のエンドポイントに対して可能な一連の応答を定義することは可能ですか?

たとえば、/movie/{id} のようなエンドポイントがある場合、一連のムービー レコードを定義して、モック サーバーで GET /movie/1 または GET /movie/2 または GET できるようにしたいと考えています。 /movie/3 を実行して、関連するレコードを取得します。

私が見た例はすべて、可能な応答を 1 つだけ定義しているようです。

次のように URL のパラメーターにハッシュを追加する Rails の方法を使用します。

使用可能なハッシュのリストに対応するように API ブループリント ドキュメントをフォーマットするにはどうすればよいですか?

• パラメーター
  • person[first] (必須, 文字列, Jane) ... 名

ドキュメントを実行すると、これは合法ではありません。

アイデアやヒントは大歓迎です！

Apiaryで API ブループリントを作成すると、ブループリントのマークダウンでエラーが発生し、次のメッセージのセマンティックな問題としてフラグが立てられます。

21 行目 - 追加の応答ヘッダーを無視し、代わりに参照モデル定義でこのヘッダーを指定します。

行 21 は、[Cars][] モデル定義を参照する行です。ヘッダーを指定しようとしているわけではなく、このメッセージが何をするように指示しようとしているのか混乱しています。誰でも問題に光を当てることができますか?

プロジェクトのドキュメントに API ブループリントを使用することを採用しました。これは素晴らしいことです。おそらく単純なことの 1 つに苦労していますが、それを概念化することはできません: 共有データベースに接続された API エンドポイントが常に既知のデータ セットを提供するようにするにはどうすればよいですか?

次のように視覚化できます。たとえば、HTTP アクションの順序がすべて順番どおりであることを確認します (実際の API 設計図構文ではなく、疑似コード)。

POST /user {user_name: 'foo'}

戻り値{id:1}

GET /user/1

戻り値{user: 'foo'}

PUT /user/1 {user_name: 'bar'}

戻り値{id: 1}

DELETE /user/1

戻り値{delete: 'success'}

他の誰かがこの問題を解決しましたか?残念ながら、API が接続されているバックエンド データベースの状態を確認できないため、これらの不整合の問題に直面しています。私たちのチームの一部は、レコードを手動で入力する場合 (たとえば、まだ POST ロジックを作成していない場合)、GET 部分を満たすドキュメント仕様を作成していますが、バックエンド DB を切り替えるとすぐに GET user/1 が常に実行されるとは限りません。 「フー」を返します。これが理にかなっていることを願っています。明確にするために質問を編集する必要があるかどうかを教えてください。

このブループリント リソースが問題を引き起こしています。

ご覧のとおり、単純な get リクエストです。つまり、http://my-host.com/api/v1/inboundSMS?number=123&message=hello%20world&key=SECRETKEYです。

しかし、私は apiary.io からエラーが発生しています

GET リクエストであるため、メッセージ本文がないため、欠落していると不平を言う理由がわかりません。

任意のフォーマット間をブリッジすることは可能ですか? ありがとうございました。

現在、Schema定義はまったく文書化されていません。私が見つけた唯一のリソースは次のとおりです。

http://support.apiary.io/knowledgebase/articles/147279-json-schema-validation https://github.com/apiaryio/api-blueprint/issues/112

ただし、これらの例のいずれも、ネストされたスキーマの作成方法について説明していません。

この応答を検証したいと思います。

私の現在の知識に基づいて、次のようなスキーマの作成を開始しました

しかし、ネストされたitemandのスキーマを作成する方法はchange?

どのタイプを使用できますか?

検証する方法はdatetime？期待値はYYYY-MM-DD HH:MM:SS