2016-08-15 1 views
1

Je ne trouve aucun code où que ce soit qui illustre l'utilisation d'un !include pour plusieurs exemples. Je suis en train de tenter ce qui suit:RAML 1.0 - Exemples multiples pour une seule réponse

200: 
    description: Successful project creation 
    body: 
    application/json: 
     type: JiraResponseSuccess 
     example: !include examples/jira/projects/success/CreateSuccess.json 
400: 
    description: User error 
    body: 
    application/json: 
     type: JiraResponseError 
     examples: 
     username: 
      !include examples/jira/projects/fail/user/UsernameFail.json 
     projectKey: 
      !include examples/jira/projects/fail/user/ProjectKeyFail.json 

Le premier exemple rend très bien (où il n'y a qu'une seule réponse) alors que la seconde ne fonctionne pas. Le syntax est correct, mais je ne comprends pas pourquoi il s'étouffe sur les instructions !include. Est-ce que j'ai une erreur ou dois-je juste attendre que l'outillage rattrape?

+1

Apparemment, plusieurs réponses ne sont tout simplement pas encore implémentées: https://github.com/raml-org/raml-spec/issues/24 –

Répondre

0

Vous pouvez spécifier différents types de contenu pour les exemples de réponse du corps, même si elles ne sont pas réellement des types de contenu réel:

200: 
    body: 
    role/admin: 
     example: !include http/list-res-200.json 
    role/admin-Search-for-User: 
     example: !include http/search-as-admin-res-200.json 
    role/member-Search-for-User: 
     example: !include http/search-as-member-res-200.json 

L'exemple ci-dessus provient de here.

Juste pour la documentation fonctionne très bien, je pars au HTML avec RAML2HTML et tout est allé sans problème.