apidoc基本

简介: apidoc基本

apidoc基本使用

  • 先下载模块,后期通过命令基于注释生成文档(仅一次)

npm install apidoc -g

  • 在项目根目录创建apidoc.json文件(仅一次)
{
    "name":"example",
    "version":"0.1.0",
    "description":"apidoc basic example",
    "title":"Custom apidoc browser title",
    "url":"http://api.github.com/v1"
  }

写接口注释

const index =async (req,res) =>{
    // 1.接受数据
    let getData =req.query
    console.log(getData);
    // 过滤
    let skip = (parseInt(getData.pageno-1)*parseInt(getData.pagesize))
    // skip--指定跳过数据  limit --限制查询数量
    // 2.获取数据
    let data  = await listModel(skip,parseInt(getData.pagesize))
    // 3.响应数据
    res.send({
        meta:{
            state:200,
            msg:"查询成功"
        },
        data:data
    })
}


相关文章
|
人工智能 语音技术
技术沙龙|3D-Speaker说话人识别多模型解析
技术沙龙|3D-Speaker说话人识别多模型解析
633 0
|
开发框架 前端开发 Java
GitHub首次开源标星20k+项目:Guns-现代化主流Java应用开发框架
Guns是一个现代化的Java应用开发框架,基于主流技术Spring Boot2 + Vue3,Guns的核心理念是提高开发人员开发效率,降低企业信息化系统的开发成本
|
Web App开发 网络安全
SSL接收到一个超出最大准许长度的记录 错误处理
SSL接收到一个超出最大准许长度的记录 错误处理
9702 0
SSL接收到一个超出最大准许长度的记录 错误处理
成功解决org.yaml.snakeyaml.scanner.ScannerException: mapping values are not allowed
成功解决org.yaml.snakeyaml.scanner.ScannerException: mapping values are not allowed
成功解决org.yaml.snakeyaml.scanner.ScannerException: mapping values are not allowed
|
7月前
|
网络协议 网络安全 网络架构
TCP连接的保持活跃机制详解
总的来说,TCP的保持活跃机制是网络通信中不可或缺的一部分,能够有效维持TCP连接的活跃性,提高网络性能,防止不必要的网络断开。这一点不论对于TCP协议的深度理解,还是对于网络通信的实际应用,都有着重要的现实意义。
253 17
|
JSON Java 开发工具
Java服务端集成Google FCM推送的注意事项和实际经验
公司的app要上海外,涉及到推送功能,经过综合考虑,选择Google FCM进行消息推送。 查看一些集成博客和官方文档,看的似懂非懂,迷迷惑惑。本篇文章除了将我实际集成的经验分享出来,也会对看到的博客及其中产生的疑惑、注意事项一一评论。 从官方文档和众多博客中,你会发现Java集成FCM推送有多种实现方式,会让生产生文档很乱,不知作何选择的困惑。
435 0
|
缓存 应用服务中间件 nginx
[nginx]lua控制响应头
[nginx]lua控制响应头
378 0
|
应用服务中间件 Shell Linux
使用logrotate定期切割nginx日志
使用logrotate定期切割nginx日志
730 0
|
NoSQL Redis Windows
Windows设置Redis服务使其开机自启
Windows设置Redis服务使其开机自启
1208 0
|
Kubernetes 应用服务中间件 nginx
K8S部署Metrics-Server服务
K8S部署Metrics-Server服务
336 1