apiblueprint - 如何在API蓝图中指定请求 header

Question

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

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

    {
        ........
    }