如何在API Blueprint中指定请求标头

Question

我正在尝试为资源定义API蓝图,该资源利用请求标头来了解要返回的内容类型.

## Offer [/offers/{offerCode}]

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

### View an Offer Detail [GET]

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

    {
        ........
    }

我希望我的要求如下: -

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

如何使用API​​ Blueprint记录该文档？

Answer 1

我不确定我是否理解你想要实现的目标但是我想说你想为请求指定标题,你可以通过以与响应相同的方式指定请求来实现.

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

    {
        ........
    }