Подтвердить что ты не робот

Node.js или Express.js REST API-документатор

Я работаю над restAPI, используя Express.js, и мне интересно, есть ли способ для меня генерировать документы API, которые позволяют пользователю просматривать определения API или даже попробовать API-вызов?

4b9b3361

Ответ 2

То, что вы ищете, это хороший генератор документации JavaScript. Я нашел приличный здесь http://apidocjs.com/example/. Это позволит вам использовать только экспресс, как указано в запросе OP.

Swagger не для создания документов, а для создания API. Таким образом, вам потребуется изучить полную систему, чтобы получить эту функцию.

Я нашел еще пару здесь, которые я еще не полностью изучил, которые кажутся многообещающими:
Docco здесь JSDoc здесь и статья о Documentor для узла

Ответ 3

Я обнаружил, что эта библиотека очень полезна, когда речь идет о сближении вашей документации и логики объявления маршрутов:

https://www.npmjs.com/package/swagger-jsdoc