Как создать Swagger UI из комментариев документации? - PullRequest
0 голосов
/ 26 февраля 2019

в SpringBoot Я всегда генерирую свой Swagger UI непосредственно из аннотаций JavaDoc, которые я использую в своем контроллере.Это очень полезно, поскольку мне не нужны никакие файлы определения Swagger.

Есть ли способ сделать то же самое в MongoDB / express / mongoose?

На самом деле, я реализовал apiDoc.js, который работает отлично.Просто добавьте @Annotations и создайте пользовательский интерфейс.

Но я хочу сделать то же самое для чванства.

Вот мой пример того, как я это сделал с apiDocs.js.Мне нужно что-то похожее для Swagger.

/**
 * @apiVersion 0.1.0
 * @api {get} /checklist/ Request All Checklists
 * @apiSampleRequest http://localhost:3005/checklist
 * @apiName Find Checklist
 * @apiGroup Checklist
 * @apiDescription Returns all CheckList with all CheckItems
 * @apiExample {curl} Example usage:
 *     curl -i http://localhost:3005/checklist
 */
router.get("/", (req, res) => {
    CheckList.find()
        .then(CheckList => res.json(CheckList))
        .catch(err => res.json(err));
});

Любые ссылки на учебники или примеры будут полезны.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...