Comments 6

Вопрос в студию..


Есть спеки API в формате Open API 3. Допустим они хорошо проработаные и документированы…
Надо автоматически генерировать документацию + удобно дописывать и линковать дополнительные (преимущественно текстовые) страницы не описаные в самом Open API документе, но выдержаные в том же стиле естественно в конечном результате?


Есть тулы которые из Open API генерят документацию более менее красиво, но не увидел там возможности интграции доп. содержания.
Может у кго-то есть ссылки на готовый Пайплайн даже? перед тем как начну костылять что-то? ;)

У Redoc есть PRO версия с порталом. Обычная версия может подгружать внешний маркдаун для info.description. Возможно, можно накостылить на основе этого.

А что используете для ведения документации? Swagger? UI для этого дела 100% свой или вы апгрейдили какой-то опенсорсный продукт?

Рассматривали Swagger изначально, но на текущий момент у нас документация генерируется и парсится из JavaDoc самописными инструментами, не было смысла тратиться на изменение этого, поэтому оставили как есть, практически без изменений. Все эти данные передаём через GraphQL, а на клиенте используем Angular Universal.
Уважаемые специалисты! Подскажите пожалуйста- какие технологии использованы на этом сайте?
Смотрю код страницы- и не вижу ничего(
view-source:https://developers.wrike.com/
Документация генерируется и парсится из JavaDoc самописными инструментами. Данные передаём через GraphQL, а на клиенте используем Angular Universal.
Only those users with full accounts are able to leave comments. Log in, please.

Information

Founded
2006
Location
США
Website
www.wrike.com
Employees
1,001–5,000 employees
Registered

Habr blog