Интерфейс Swagger для обмена сообщениями API

Question

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

Swagger is почти что мне нужно для документирования API на основе сообщений. Например, для Command Message я хотел бы сказать «Command» вместо «Post», и вместо «path» я хотел бы иметь имя Command.

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

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

Answer 1

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

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

Из того, что я собираюсь, вы пытаетесь описать что-то другое.

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