api - RAML: リソースでの uriParameters の参照

Question

私は RAML で API 仕様を書いていますが、動的な MIME タイプを作成するために uri パラメータを参照できるかどうか疑問に思っていました。の線に沿った何か

baseUri: http://api.mycompany.com/{version}

/first_resource:
  get:
    responses:
      200:
        body:
          application/custom.mime.type.{version}+json

Answer 1

現在 (v 0.8) このような動作は仕様の一部ではありません。

サンプルコードで求めていることは、開発者にエラーのパスを追加する可能性があります-サーバーの実装が対応する必要があります:どこかでリソースのリクエストhttp://api.mycompany.com/v1が行われたが、何らかの理由でContent-Type: custom.mime.type.v2+json-Header が含まれている場合はどうなりますか?

カスタムのバージョン管理された MIME タイプを使用する場合、このような状況を設計上回避するために、バージョン管理されていない URL を使用することをお勧めします。クライアントが必要なヘッダーを送信できない場合でも、クエリ文字列または what-have-you... を使用してフォールバックを提供できます。