2017-04-14 32 views
0

我是api-blueprint的新用户。我无法找到如何引用文档第二行中定义的HOST。我想实现主机地址的这样的组合和端点:api-blueprint如何参与definied HOST

HOST: https://www.mybaseurl.com 
###API Request Example 
url: {{HOST}}/v1/api/token?key=partnerKey&secret=partnerSecret 

回答

1

答案如何与主机的使用定义端点如下:

FORMAT: 1A 
HOST: https://www.mybaseurl.com 

# Name your API 

## Group API Requests 

## API Request Example [/v1/api/token?{key,secret}] 

+ Parameters 

    + key: partnerKey (string) - An unique identifier of the partner 
    + secret: partnerSecret (string) - An secret of the partner 

### Name of the action using the following HTTP method in brackets [GET] 

+ Request Plain Text Message 

    + Headers 

      Accept: text/plain 

+ Response 200 (text/plain) 

    + Headers 

      X-My-Message-Header: 42 

    + Body 

      Hello World!