Генератор документации gRPC

Поддерживает ли gRPC создание документации для таких сервисов, как Swagger? (или есть какой-то сторонний инструмент, который делает это?)


grpc documentation-generation
person Max Ng    schedule 04.08.2015    source источник

Ответы (2)


arrow_upward
7
arrow_downward

protoc-gen-doc – это protoc подключаемый модуль, который генерирует HTML-документы. используя шаблоны Go HTML. Хотя он больше не используется компанией-спонсором, он выглядит как хорошая отправная точка.

person Eric Drechsel    schedule 03.02.2017

arrow_upward
2
arrow_downward

Ваши профайлы — это документация. Вы можете оставить комментарии, чтобы уточнить значение параметров или методов обслуживания.

person Timmy    schedule 17.08.2015
comment
Я предполагаю, что файл proto может быть источником документации, но все же желательно сгенерировать красивый HTML со ссылками между типами сообщений, примерами вызовов служб и всеми подобными вещами. - person Max Ng; 19.08.2015
comment
Поиск в Google generate html documentation for grpc дает ссылку ссылка, которую вы можете попробовать использовать. Кроме того, вы можете создавать документацию из исходного кода, созданного из протофайлов. Например. в источнике, сгенерированном java, все комментарии из вашего файла .proto появятся в javadocs. - person Timmy; 19.08.2015