Чванство поддерживает бережливость? - PullRequest
0 голосов
/ 10 декабря 2018

В прошлом я использовал Swagger для Java REST API, и это был лучший из доступных инструментов для этой цели.

Поддерживает ли Swagger создание документации для файлов Thrift RPC?

Ответы [ 2 ]

0 голосов
/ 16 декабря 2018

Краткий ответ Нет - Swagger не поддерживает thrift.

Это наиболее близко к swagger, который, к счастью, поддерживается из коробки для thrift

Эта команда генерирует документацию HTML для данного thrift.файл.

thrift -r --gen html  your-thrift.thrift

Также при копании для этого обнаружил, что вы можете сгенерировать автоматическую диаграмму структуры данных, определенной в комиссионном файле

thrift -r --gen gv your-thrift.thrift
dot -Tpdf -o your-thrift.pdf gen-gv/your-thrift.gv
0 голосов
/ 10 декабря 2018

Файлы Thrift RPC

Основным документом Thrifts является Thrift IDL или язык описания интерфейса .

Этот IDL описывает API-интерфейс на высоком уровне и в то же время служит входом для генерации кода, необходимого для привязок языка.

Для этого файл Thrift IDL содержитне только объявления, но также разрешается использовать в нем обычные комментарии ботов и так называемые "комментарии к документам".Многие привязки языка поддерживают прямое преобразование из doc-комментариев в специальную форму языка, поэтому документация также найдет свой путь в сгенерированный код.

Существует хороший пример для документации внутри файла Thrift IDL в исходном дереве.Кроме того, рассмотрите возможность использования генератора GraphViz (-gen gv) для получения графической документации для вашего IDL или генератора HTML (-gen html) или (довольно старого) генератора XSD.

Предложение Swagger (или Apiary)интерактивный способ пользовательского интерфейса для игры с реализацией.Это то, что сегодня не имеет аналогов в Thrift.

Поддерживает ли swagger создание документации для файлов Thrift [...]?

Swagger работает с сервисами RESTful.Thrift - это система RPC, и у этих двух есть некоторые концептуальные различия.Следовательно, очень маловероятно, что чванство когда-либо придет к тому, что сможет документировать что-либо кроме REST.

Смежный вопрос: Можно ли использовать Swagger для SOAP?

...