Comment réutiliser JSON dans l'exemple RAML

Question

je les fichiers suivants

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 
       } 
      } 

Le JSON utilisateur est présent dans plus d'exemples et je veux pour le réutiliser. J'utilise raml2html et il compile à

alors comment ce que je fais?

Answer 1

J'ai utilisé les paramètres avec succès dans le passé. Vous ne pourrez pas placer un paramètre dans un fichier inclus car RAML considère tous les fichiers inclus comme des chaînes. Mais vous pouvez faire quelque chose comme ça dans votre profile.raml:

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

Le RAML 200 Tutorial a un bon exemple d'explication et le code (voir extraits ci-dessous) sur la façon de déclarer les paramètres et les les passent, je recommande fortement la lecture de la. tutoriel entier cependant.

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