swagger生成api文档

//index.js
var path=require('path')
var express=require('express')
var app=new express()

var swaggerJsDoc=require('swagger-jsdoc')

var swaggerUi=require('swagger-ui-express')

var options={definition:{openapi:'3.0.0',
        info:{title:'项目',version:'1.0.0',description:'描述'}},
        apis:[path.join(__dirname,'/routes/*.js')]
    }

var swaggers=swaggerJsDoc(options)

var userRouter=require('./routes/user')

app.use('/api-js-doc',swaggerUi.serve,swaggerUi.setup(swaggers))
app.use('/user',userRouter)
app.listen(4000)


//user.js
var express=require('express')
var router=express.Router()
/**
   * @swagger
   * /user/hello:
   *   get:
   *     description: Returns the homepage
   *     responses:
   *       200:
   *         description: hello world
   */

router.get('/hello',(req,res)=>{
    res.send('world')
})
module.exports=router

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值