ramlリソースへの一般的な回答を含める方法

Question

私はraml文書を持っており、新しいAPIのドキュメントをそのドキュメントに追加しようとしています。

私は基本的なRAMLドキュメントを使いました。

私はramlファイルを持っています。

そして実際RAML含有量がRAML上記でtest.raml

#Filename: test.raml 
displayName: Test RAML Inheritance 
description: Testing for RAML inheritance for responses. 

get: 
    description: Get all TEST 
    headers: 
     name: 
      description: name required in each request 
      example: testname 
      required: true 
    responses: 
     200: 
      description: SUCCESS 
      body: 
       application/json: 
        example: | 
         {} 
     400: 
      description: BAD REQUEST 
      body: 
       application/json: 
        example: | 
         {"error": "Bad Request"} 
     500: 
      description: INTERNAL ERROR 
      body: 
       application/json: 
        example: | 
         {"error": "Internal Error"} 

post: 
    description: Get all TEST 
    headers: 
     name: 
      description: name required in each request 
      example: testname 
      required: true 
    responses: 
     200: 
      description: SUCCESS 
      body: 
       application/json: 
        example: | 
         {"message": "Created"} 
     400: 
      description: BAD REQUEST 
      body: 
       application/json: 
        example: | 
         {"error": "Bad Request"} 
     500: 
      description: INTERNAL ERROR 
      body: 
       application/json: 
        example: | 
         {"error": "Internal Error"} 


/{test_id}: 
    description: TEST DETAILS 
    get: 
     description: Retrieve resource own by x-user-name 
     headers: 
      name: 
       description: name required in each request 
       example: testname 
       required: true 
     responses: 
      200: 
       description: SUCCESS 
       body: 
        application/json: 
         example: | 
          {"message": "Details"} 
      400: 
       description: BAD REQUEST 
       body: 
        application/json: 
         example: | 
          {"error": "Bad Request"} 
      500: 
       description: INTERNAL ERROR 
       body: 
        application/json: 
         example: | 
          {"error": "Internal Error"} 

に、400と500応答が一般的であり、そしてnameヘッダが一般的です。

これを一度書き、すべてのリソースに追加するにはどうすればよいですか？私はtraitsと<<:の両方を試してみました。

Answer 1

形質は適切な解決策です。

トレイト

traits: 
    nameHeader: 
    headers: 
     name: 
     description: name required in each request 
     example: testname 
     required: true 

使用形質を定義

明示的にあなたの要求仕様内でそれを言及する必要があり、この特性を使用するには：これはあなたのnameヘッダーのシナリオの例です。

/{test_id}: 
    description: TEST DETAILS 
    get: 
    description: Retrieve resource own by x-user-name 
    is: [nameHeader] 
    responses: 
     200: 
     description: SUCCESS 
     body: 
      application/json: 
      example: | 
       {"message": "Details"} 

dあなたの反応を確かなものにする