Пользовательский интерфейс Swagger для API обмена сообщениями

Я хотел бы знать, возможно ли следующее.

Swagger — это почти то, что мне нужно для документирования API на основе сообщений. Например, для Командного сообщения я хотел бы сказать "Команда" вместо "Опубликовать", и вместо «пути» я хотел бы иметь имя команды.

В спецификации упоминается, что поставщик Расширения возможны с использованием свойств «x-», но я 1) не нахожу примеров того, как это сделать, и 2) не уверен, что использование этих свойств поможет мне достичь моих целей.

Может ли кто-нибудь указать мне на некоторые ресурсы, которые могут помочь мне двигаться дальше?


person Roy Truelove    schedule 14.05.2015    source источник
comment
Вы нашли альтернативу чванству для документирования вашего API обмена сообщениями?   -  person ben schwartz    schedule 09.12.2015
comment
Нет, извини, чувак. Все руководство   -  person Roy Truelove    schedule 10.12.2015
comment
Ой! Спасибо за ответ   -  person ben schwartz    schedule 10.12.2015


Ответы (1)


Swagger предназначен для документирования API REST, основанных на командах HTTP. Нельзя заменять глаголы или изобретать новые.

Расширения поставщиков позволяют добавлять дополнительную информацию, которую не позволяет спецификация, но в конечном итоге они по-прежнему предназначены для REST API.

Насколько я понимаю, вы пытаетесь описать что-то другое.

Мы приветствуем предложения по дополнительным путям для Swagger (то есть по охвату не-REST API), и для этого я предлагаю открыть вопрос в репозитории спецификации swagger.

person Ron    schedule 15.05.2015
comment
Спасибо, Рон, после глубокого погружения в код я пришел к такому же выводу. - person Roy Truelove; 15.05.2015
comment
Мы смотрим на одно и то же. В основном думает о добавлении конечных точек контроллера POST, которые просто отправляют POST в очереди сообщений, и помещают чванство на передний контроллер, чтобы можно было сгенерировать документацию, и вы могли бы отправлять сообщения POST через очередь. Что-то такое... - person Todd W Crone; 09.02.2017