Уценка для получения ресурса в версии v1 API с Apiary

Я бы хотел, чтобы документация по API была сегментирована по версиям API. Итак, мой хост: http://api.clementlevallois.net/apitest/

Версия API: v1

Ресурс: get/{id}

И я бы хотел, чтобы документ генерировал:

http://api.clementlevallois.net/apitest/v1/get/{id }

Но часть «v1» сжата, и я просто получаю: /получить/ {идентификатор}

Вот моя уценка:

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?


apiary.io
person seinecle    schedule 18.12.2015    source источник
comment
Может быть, это может быть полезно: или план API поддерживает управление версиями API"> stackoverflow.com/questions/32419425/   -  person tomjcz    schedule 18.12.2015
comment
действительно, спасибо. Управление версиями — одна из лучших практик разработки API, и это, вероятно, следует учитывать в документе: разные схемы для разных версий одного и того же API звучат неправильно.   -  person seinecle    schedule 19.12.2015

Ответы (1)


arrow_upward
0
arrow_downward

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

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

person Almad    schedule 18.12.2015