問題タブ [apiblueprint]

Python、npm (すべてパスに追加)、VS 2013 をインストールし、api-blueprint-preview という atom パッケージをインストールしようとしました。

私のボックスは Windows 8.1 を実行しています。

何か案は？ありがとう！

テスト目的でモック API サービスを作成しようとしています。私たちはすでに別のチームで Apiary を使用しているので、そこから始めています。

これまでのところ、2 つの別々の呼び出しを行いたい場合は、両方の要求をモックアウトする必要があることに気付きました。たとえば、ID 1 と 2 のメモを取得するには、次のような応答を明示的に書き出す必要があります。

/メモ/1 /メモ/2

これを回避する方法はありますか？確かに、私はまだ青写真の作成に力を入れています。

POST/PUT のリクエストボディの属性/パラメータを記述/定義する方法を理解しようとしています。これは私がやろうとしていることの例ですが、ドキュメントのどこにも見つかりません (公開されている Apiary ドキュメントのマークダウンを表示する方法があればいいのにと思います): http://docs.bynder. apiary.io/#reference/metaproperties/metaproperty-access/save-new-metaproperty

「リクエスト」セクションの説明と属性定義を参照してください。それ、どうやったら出来るの？

文書化する API エンドポイントがたくさんあり、POST および PUT 要求のペイロードは複雑になる可能性があります。私はapiblueprintでそれらを文書化しています。apiblueprint を使用して URI パラメーターを文書化できる方法がとても気に入っています。見栄えがよく、読者が必要とするすべての情報（必須、文字列または整数、選択肢/値のリスト、例の提供）を提供できます。

Request セクションを見ると、同じレベルの元のドキュメントを提供する方法がわかりません。私が見たリクエスト セクションは、リクエストの例を示しているだけです。

必要な id という名前の整数を取る単純なペイロードを扱っているとします。現在、私のリクエストセクションは次のようになります。

ヘッダー

コンテンツ タイプ: アプリケーション/json

体

{"id":"123"}

リクエストの本文はこれほどスパースである必要がありますか? REST ペイロードのすべての制約/要件をユーザーに伝える最善の方法は何ですか?

SOAP Web サービスをモックしていますが、リクエストの本文に関係なく、デフォルトの最初のレスポンスしか返されません。

ドキュメントのMultiple Transaction Examplesに基づいて試みを行っていますが、何が間違っているのか混乱しています。

例として：

上記の例では、2 つの異なる要求を投稿しても、最初の応答しか受信しません。リンクされたドキュメントに基づいて、これは可能になるはずです。

URI パラメータの検証を定義することは可能ですか?

• (つまり、、、、maxValなどminVal? maxLength)

そうでない場合、少なくともパラメーターの有効範囲を文書化するための適切な回避策はありますか?

2 つのリソース間の次の関係を検討してください。

• 大学には多くの学部があります
• 学部は大学に所属しています

明らかに、教員はここでは一流のリソースではありません。

次に、次の操作のためのエンドポイントが必要です。

• この大学、このファームに新しい学部を作成します。2 つの操作でこれを行う 1 つの方法。
  • POST /faculties/
  • PUT /college/1/faculties
• この大学から学部を削除します。再び2つの操作
  • GET /college/1/faculties：関連する学部のリスト。それぞれに のような自己 URL が含まれます/faculties/1。
  • DELETE /college/1/faculties/1: URL は見栄えが良くなりますが、この URL を公開するにはどうすればよいですか?
• その大学の下に 1 つ以上の学部を追加します。
  • PUT /college/1/facultiesこの大学の学部の完全なリストを受け入れます。
• その特定のセクターを完全に削除します。
  • DELETE /sectors/1: 良さそうに見えますが、 のキャッシュを処理する必要があり/faculties/1/sectorsます。

この場合、より良いアプローチは何でしょうか？メンバーシップ リソースの公開について読んだことがありますが、そのアプローチでは、大学に 10 の学部がある場合、メンバーシップからすべての学部を取得するには 10 回の http 呼び出しが必要になります。

さらに、これは完全なリレーションシップ ツリーのほんの一部にすぎません。これをさらに拡張するために、システムが

• 学部には多くの学科があります
• 学科には研究室がたくさんあります。

さらに、RESTful アーキテクチャでは、クライアントが URL を設定することはありません。

なにか提案を？

通常、リソースには複数の get メソッドがあります。単数形を取得するか、クエリ パラメータで多数を取得します。これは設計図でどのように表されますか? 2 つのリソースを使用してそれを行うことができますが、同じリソースであるため、私の意見では正しくありません。

この質問に関連して、URIがリソースレベルで定義されている場合、PUTをリソースに追加するにはどうすればよいですか。

理想的には、これは物事が書かれるべきだと私が思う方法ですが、編集者はそれを好きではありません. HTTP_ACTION と URI を組み合わせることができるドキュメントを見つけましたが、エディターはリソース レベルで URI を必要としているようです。