在SpringBoot中,我总是直接从我在控制器中使用的JavaDoc注释直接生成Swagger UI。这非常有用,因为我不需要任何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));
});
任何喜欢教程或示例的人都会有所帮助。