Come specificare le intestazioni delle richieste nel modello API

Question

Sto provando a definire un modello API per una risorsa che utilizza le intestazioni delle richieste per capire quale tipo di contenuto restituire.

## Offer [/offers/{offerCode}] 

+ Parameters 
    + offerCode: summer2015 (required, string) - alphanumeric offer code 

### View an Offer Detail [GET] 

+ Response 200 (application/vnd.v0.1.0+json) 

    { 
     ........ 
    } 

voglio che la mia richiesta di essere come segue: -

GET /offers/summer2015 HTTP/1.1 
Host: my.api.com 
Accept: application/vnd.v0.1.0+json 

Come posso documentare che l'uso di API Blueprint?

Answer 1

Non sono sicuro di aver capito cosa si desidera ottenere, ma direi che si desidera specificare l'intestazione per richiesta e lo si può fare specificando la richiesta allo stesso modo della risposta.

## Offer [/offers/{offerCode}] 

+ Parameters 
    + offerCode: summer2015 (required, string) - alphanumeric offer code 


### View an Offer Detail [GET] 

+ Request 

    + Headers 

      Accept: application/vnd.v0.1.0+json 


+ Response 200 (application/vnd.v0.1.0+json) 

    { 
     ........ 
    }