如何在 API 蓝图中指定请求 headers

Question

我正在尝试为资源定义一个 API 蓝图，该蓝图利用请求 headers 来理解 return 的内容类型。

## 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 蓝图记录下来？

Answer 1

我不确定我是否理解你想要实现的目标，但我会说你想为请求指定 header 并且你可以通过指定请求与响应相同的方式来做到这一点。

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

    {
        ........
    }

如何在 API 蓝图中指定请求 headers

How to specify request headers in API Blueprint

apiblueprint