2015-09-06 2 views
3

Поддерживает ли api-проект или Apiary.io концепцию версии вашего API? В частности, я версионности мой API через URI, как это:Поддерживает ли Apiary.io и/или API Blue API версию api?

GET /api/v2/SomeResource/ 

В приведенном выше примере, это означает, что я звоню версии 2 («v2») в API. Поддерживает ли апи план? Как я могу документировать несколько версий данного действия или всего API?

+0

Кроме того, для чего стоит проверить статью mnot о версии https://www.mnot.net/blog/2011/10/25/web_api_versioning_smackdown – Zdenek

ответ

6

Вы можете использовать HOST заголовок, чтобы показать, что:

HOST: http://example.com/api/v2 собирается префикс всех ресурсов с /api/v2.

В API Blueprint, если вы используете префикс URL, API-интерфейсы считаются разными, поэтому для них нужно использовать разные чертежи.

Если вы используете типы носителей с суффиксом версии для этого, вы можете просто указать правильные Content-Type в заголовках, и они будут правильно использоваться для согласования контента в макетном сервере.

+0

Хорошо, поэтому нет особой поддержки для управления версиями URL в Пасеке в это время. Справедливо. – jakejgordon

+0

@jakejgordon Как будет выглядеть «специальная поддержка»? – Almad

+1

Не уверен - возможно, возможность инициировать новую версию API через пользовательский интерфейс, выбрать новый номер версии, а затем добавить новые или измененные действия в новый проект. Сомнение в том, что это может быть связано только с файлом проекта API - вероятно, потребуются дополнительные метаданные в Пасивере. – jakejgordon

Смежные вопросы