Документация по API Sails.js

Я хочу разработать API с использованием шаблона MVC. Я нашел инфраструктуру парусов интересной, и я хотел бы знать, можно ли настроить swagger или что-то вроде парусов для создания документации моего API (например, что-то вроде swagger-express для экспресса).

Спасибо!


node.js sails.js swagger model-view-controller
person krakig    schedule 03.03.2015    source источник
comment
Вы можете попробовать сделать это самостоятельно, swagger нуждается только в конечной точке, откуда можно прочитать всю информацию о конечных точках сервера или, возможно, в спецификации github.com/swagger-api/swagger-spec   -  person Osukaa    schedule 09.03.2015
comment
Я думаю, я должен попытаться сделать это, не похоже, что кто-то еще работал над решением.   -  person krakig    schedule 10.03.2015
comment
Мы работаем над этим.   -  person Travis Webb    schedule 31.03.2015
comment
Библиотека sails-hook-swagger-generator должна помочь в выполнении этой задачи практически без настройки github.com/theo4u/sails-hook-swagger-generator   -  person Theophilus Omoregbee    schedule 09.08.2017

Ответы (2)


arrow_upward
5
arrow_downward

Эта функция находится в разработке. Если вы хотите помочь, мы все можем сотрудничать здесь: https://github.com/balderdashy/sails/issues/1094

Обновление (август 2015 г.):

Ознакомьтесь с этим Sails Hook, который предлагает встроенную интеграцию Swagger. Он компилирует все связанные маршруты в Sails и создает документ Swagger 2.0: https://github.com/tjwebb/sails-swagger

person Travis Webb    schedule 04.04.2015
comment
Удалось ли вам получить информацию о том, как реализовать что-то подобное с помощью приложения Sails Express? - person Armel Larcier; 16.07.2015
comment
Когда я использую паруса-чванство, он говорит: - ошибка: функция начальной загрузки выдала ошибку после вызова обратного вызова :: Ty peError: невозможно установить свойство 'doc' из неопределенного. У вас есть какая-либо документация о том, как реализовать - person rash111; 03.09.2015

arrow_upward
2
arrow_downward

Вот что я сделал, чтобы моя документация работала с парусами.js: вы можете скачать swagger-ui здесь: https://github.com/swagger-api/swagger-ui или через npm (npm install swagger-ui).

Затем в папке активов вашего проекта паруса создайте папку, указывающую на папку swagger (например, "docs", чтобы вы могли получить доступ к своей документации через your_url:port/docs)

person krakig    schedule 18.05.2015