А существуют ли какие-то визуальные редакторы для написания документации к API в формате OpenAPI?

Question

[Роми]

сабж )

Собственно, есть, например Swagger, но он ведь просто для отображения написанного.

А есть ли какие-то программы, чтобы тыкать мышью и немножко писать, а оно на основе этого само генерило YAML в формате OpenAPI?

Comments

[Василий Банников]

А что предполагается мышью натягивать?)
Пути к эндпоинтам? Регулярки? Выбирать метод из дропдаунов?

Кажется, что проще 1 раз разобраться с yaml и всё

[Роми]

Василий Банников, да там разбиратсья особо не с чем в общем-то, просто нужно "руку набить")) но я просто думал мб есть какие-то более легкие пути. Для html же были раньше визуальные редакторы, почему бы и здесь им не быть..

[Василий Банников]

Роми, ну просто openapi и html это немного разные вещи)

[Роми]

Василий Банников, ))

на самом деле, тыкать можно было бы в например выпадающие списки с типами для эндпойнтов, и т.д.

то есть UI тут прикрутить есть куда

[Василий Банников]

Роми,

например выпадающие списки с типами для эндпойнтов

А если у тебя тысяча разных типов? Будешь тысячу разных вариантов скроллить?
Чем автокомплит не угодил? - начинаешь писать и вот тебе подсказки.

Answer 1

[Василий Банников]

Вот первое что нашёл:
https://stoplight.io/api-design

Гуглить по словосочетанию openapi designer