2016-04-14 9 views
0

Ich bin neu in der Dokumentation rechts API RAML.In ein Beispiel unter Verwendung sah ich einen Code wieUnterschied zwischen & standardResponses und * standardResponses in raml

resourceTypes: - base: get?: responses: &standardResponses put?:
responses: *standardResponses post?: responses: *standardResponses delete?: responses: *standardResponses
- collection: type: base
get: is: [showActive] responses: 200: body:
application/json: schema: <<schema>> post: body: application/json: schema: <<schema>> responses: 200: body:
application/json: schema: <<schema>>

Also, was ist der Unterschied zwischen & standardResponses und * standardResponses? Und warum haben wir das Fragezeichen (?) Nach http-Methoden verwendet und was bedeutet das, wenn wir type: base verwenden?

Antwort

1

& {name} - einen Block deklarieren * {name} - den Block

Einfaches Beispiel verwenden: in jeder Antwort

/customers: 
    get: 
    responses: 
     200: 
     headers: &commonResponseHeaders 
      Server-Transaction-Id: 
      description: Transaction id in the middleware. Can be used for debugging. 
      type: string 
      required: true 
     body: 
      example: !include examples/customers.json 
      schema: !include schemas/customers.json 
    /{customerId}: 
    get: 
     responses: 
     200: 
      description: The request was successful and a customer was found 
      headers: *commonResponseHeaders 
     404: 
      description: Customer was not found with `customerId = {customerId}` 
      headers: *commonResponseHeaders 

Sie müssen also nicht wiederholen gleiche Kopfzeilen.