3 года назад
Подборка инструментов для документирования JS
В подборке представлены инструменты, которые позволят вам быстрее документировать JS код. 👉 JSDoc — Набор инструментов, автоматически создающий многостраничную текстовую документацию (HTML, JSON, XML и т. д.) из комментариев из исходного кода на JavaScript.  👉Docco — Создаёт HTML-документ для отображения ваших комментариев, чередующихся с кодом. Поддерживает не только JavaScript, но и другие языки: Python, Ruby, Clojure и прочие. Написан на Literate CoffeeScript 👉apiDoc — Инструмент для генерации документации, которая основывается на комментариях определённого вида...
7 месяцев назад
Как задокументировать API с помощью Swagger в Node.js
В типичном сервере на Node.js с Express есть несколько основных компонентов: Swagger берет данные из router, формируя на их основе понятное описание API. Для работы Swagger в проекте установим два пакета: npm install swagger-ui-express swagger-autogen Создадим файл в корне проекта: swagger.js const swaggerAutogen = require('swagger-autogen')(); const outputFile = './swagger_output.json'; // Файл, куда сохранится документация const endpointsFiles = ['./routes/*.js']; // Пути к файлам с маршрутами swaggerAutogen(outputFile, endpointsFiles); * Когда мы запустим этот файл (node swagger...