使用 Apiary 在 API 的 "v1" 版本中使用 Markdown 获取资源
Markdown to get resource in "v1" version of the API with Apiary
我想要一个 API 文档,按 API 的版本分段。
所以我的主机是:http://api.clementlevallois.net/apitest/
api版本为:v1
资源为:get/{id}
我希望文档生成:
http://api.clementlevallois.net/apitest/v1/get/{id}
但是 "v1" 部分被压缩了,我只得到:http://api.clementlevallois.net/apitest/get/{id}
这是我的降价:
FORMAT: 1A
HOST: http://api.clementlevallois.net/apitest/
# API Test
"ApiTest" is a simple API I created to learn for myself how to create, publish and document APIs.
At the moment it is very basic:
type: http://api.clementlevallois.net/apitest/v1/get/YOUR NAME HERE
And check what it returns.
## Version 1 [/v1/]
Resource representing *the version 1* of the API.
### Request a greeting [GET /get/{username}]
+ Parameters
+ username (text, required) - The name that will be greeted.
+ Response 200 (application/json)
{"username":"username"}
如何将 "v1" 部分插入到 URI 中?
如果蓝图仅与 v1
相关,则它本身就是其所在位置的一部分,因此应包含在 HOST
:
中
HOST: http://api.clementlevallois.net/apitest/v1/
我想要一个 API 文档,按 API 的版本分段。 所以我的主机是:http://api.clementlevallois.net/apitest/
api版本为:v1
资源为:get/{id}
我希望文档生成:
http://api.clementlevallois.net/apitest/v1/get/{id}
但是 "v1" 部分被压缩了,我只得到:http://api.clementlevallois.net/apitest/get/{id}
这是我的降价:
FORMAT: 1A
HOST: http://api.clementlevallois.net/apitest/
# API Test
"ApiTest" is a simple API I created to learn for myself how to create, publish and document APIs.
At the moment it is very basic:
type: http://api.clementlevallois.net/apitest/v1/get/YOUR NAME HERE
And check what it returns.
## Version 1 [/v1/]
Resource representing *the version 1* of the API.
### Request a greeting [GET /get/{username}]
+ Parameters
+ username (text, required) - The name that will be greeted.
+ Response 200 (application/json)
{"username":"username"}
如何将 "v1" 部分插入到 URI 中?
如果蓝图仅与 v1
相关,则它本身就是其所在位置的一部分,因此应包含在 HOST
:
HOST: http://api.clementlevallois.net/apitest/v1/