API Blueprint'te istek üstbilgileri nasıl belirlenir

Question

Hangi içerik türünün döndüğünü anlamak için istek başlıklarını kullanan bir kaynak için bir API blueprint'i tanımlamaya çalışıyorum.

## Offer [/offers/{offerCode}] 

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

### View an Offer Detail [GET] 

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

    { 
     ........ 
    } 

Ben şöyle isteğim olmak istiyorum: -

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

Bunu nasıl kullanarak API Blueprint belge olabilir?

Answer 1

Neyi başarmak istediğinizi anladığımdan emin değilim, ancak istek için üstbilgi belirtmek istediğinizi söyleyebilirim ve isteğinizi yanıtla aynı şekilde belirterek bunu yapabilirsiniz.

## 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) 

    { 
     ........ 
    }