Wie json in RAML Beispiel

Question

wiederzuverwenden Ich habe die folgenden Dateien

user.json

"user": { 
    "id": 1, 
    "name": "nameuser", 
    "online": true, 
    "profile": { 
    "photo": "", 
    "validated": true, 
    "popular": true, 
    "suspect": false, 
    "moderator": false, 
    "age": "22 ani", 
    "gender_id": "M" 
    } 
} 

profile.raml

displayName: Profile 
get: 
    description: Get profile data 
    queryParameters: 
    userId: 
     description: The user id for which we are requesting the profile data 
     type: integer 
     required: true 
    responses: 
    200: 
     body: 
     application/json: 
      example: | 
      { 
       "user": !include user.json, 
       "details": { 
       "friend": true 
       } 
      } 

Der Benutzer json in mehr Beispiele vorhanden ist, und ich will um es wiederzuverwenden. Ich verwende raml2html und es kompiliert es

so wie kann ich dies tun?

Answer 1

Ich habe Parameter in der Vergangenheit erfolgreich verwendet. Sie können einen Parameter nicht in eine enthaltene Datei einfügen, da RAML alle enthaltenen Dateien als Zeichenfolgen betrachtet. Aber Sie können in Ihrem profile.raml etwas tun:

example: | 
     { 
      "user": <<userItem>>, 
      "details": { 
      "friend": true 
      } 
     } 

Die RAML 200 Tutorial hat eine gute Erklärung und Code-Beispiele (siehe Schnipsel unten), wie Parameter zu erklären, und sie geben sie in ich das Lesen sehr empfehlen. ganzes Tutorial obwohl.

resourceTypes: 
    - collection: 
     description: Collection of available <<resourcePathName>> in Jukebox. 
     get: 
     description: Get a list of <<resourcePathName>>. 
     responses: 
      200: 
      body: 
       application/json: 
       example: | 
        <<exampleCollection>> 

/songs: 
    type: 
    collection: 
     exampleCollection: !include jukebox-include-songs.sample