2015-12-18 4 views
0

Я хотел бы иметь документацию API, сегментированную для каждой версии API. Так что мой хозяин: http://api.clementlevallois.net/apitest/Markdown, чтобы получить ресурс в версии «v1» API с Apiary

версия АФИ: v1

Ресурс: Получить/{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?

+0

Может быть, это может быть полезно: http://stackoverflow.com/ вопросы/32419425/does-apiary-io-and-api-blueprint-support-api-versioning – tomjcz

+0

действительно, спасибо. Версии - одна из лучших практик разработки apis, и это, вероятно, следует учитывать в документе: разные чертежи для разных версий одного и того же api не звучат правильно. – seinecle

ответ

0

Если проект о v1 только, это по своей сути часть, где это место, поэтому он должен быть включен в HOST:

HOST: http://api.clementlevallois.net/apitest/v1/