#node.js #api-doc
Вопрос:
Я использую apidoc (https://apidocjs.com) для создания документации REST API для проекта nodejs. На данный момент я создаю статический веб-сайт, содержащий документацию npx apidoc [...-args values]
. Это создает громоздкий статический веб-сайт HTML-CSS-JS, и процесс занимает довольно много времени.
Все, что я хочу, чтобы apidoc сделал, это просто дал мне api_data.json (который содержит фактическую информацию о REST API) и ничего больше.
Документы на их веб-сайте не помогут. Я рассмотрел и попробовал некоторые решения, и вот почему они не сработали для меня:
apidoc-markdown
— Это создает файл уценки, это не то, что мне нужно.swagger
amp; все другие пакеты, связанные с swagger — они еще более громоздкие и требуют написания кода, а не комментариев.
Любая помощь или руководство будут оценены по достоинству.