Как сгенерировать документацию OpenAPI 3 из файлов protobuf

Question

У меня есть API, сгенерированный из protobuf, и я хотел бы сгенерировать документацию, соответствующую OpenAPI 3 spe c. Я рассмотрел ряд утилит, но не нашел комбинации, которая работает.

Кто-нибудь знает путь от protobuf до OpenAPI 3, по которому я могу следовать?

Answer 1

У Google есть репозиторий на GitHub, чтобы сделать именно это. Он содержит примеры для OpenAPI v3 (и v2) о том, как должен выглядеть эквивалентный код protobuf. * ​​1003 *

Вот средняя статья , которая объясняет сквозной gRP C + HTTP (используя Protobuf и Swagger соответственно) реализация сервера и документация, шаг за шагом. Это пример OpenAPI v2, но аналогичные концепции применимы к OpenAPI v3.

Существуют другие репозитории , которые могут делать то же самое, но я бы порекомендовал использовать исходный код, который на самом деле идет из самого источника. :)

Надеюсь, это поможет!