APIDOC

apidoc -i "文件所在目录" -o "输出目录"

代码示例：

var express = require('express');
var router = express.Router();
const multer = require('multer')

const upload = multer({dest: 'public/uploads/'})

const UserController = require('../controllers/UserController')

/**
 *
 * @api {post} /api/user 添加用户
 * @apiName addUser
 * @apiGroup userGroup
 * @apiVersion  1.0.0
 *
 *
 * @apiParam  {String} username 用户名
 * @apiParam  {String} pwd 密码
 * @apiParam  {Number} age 年龄
 * @apiParam  {File} avatar 头像
 *
 * @apiSuccess (200) {Number} ok 标识是否成功的字段
 *
 * @apiParamExample  {multipart/form-data} Request-Example:
 * {
 *     username: "username",
 *     pwd: "password",
 *     age: 24,
 *     avatar: File
 * }
 *
 *
 * @apiSuccessExample {json} Success-Response:
 * {
 *     ok: 1
 * }
 *
 *
 */
router.post('/user', upload.single('avatar'), UserController.addUser)

router.put('/user/:id', UserController.updateUser)

router.delete('/user/:id', UserController.deleteUser)

router.get('/user', UserController.getUser)

router.post('/login', UserController.login)

router.get('/logout', UserController.logout)

module.exports = router;

在项目根目录下创建一个apidoc.json文件

代码示例：

{
  "name": "接口文档",
  "version": "1.0.0",
  "description": "文档描述",
  "title": "标题"
}