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
    })
}


相关文章
|
XML JSON 缓存
小红书获得小红书笔记详情 API 返回值说明
-- 请求示例 url 默认请求参数已经URL编码处理 curl -i "https://api-gw.onebound.cn/smallredbook/item_get_video/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&num_iid=649c46ab000000002702ad36"
|
JavaScript 前端开发 数据库
让你少踩坑的fastadmin教程(3)
让你少踩坑的fastadmin教程
1429 0
让你少踩坑的fastadmin教程(3)
|
7月前
|
XML 人工智能 JSON
CodeFuse能力测评及优化技巧
近一年来大模型越来越火,在研发领域的代码大模型也如雨后春笋般出现。蚂蚁也发布了自己的百灵代码大模型 CodeFuse,作为内部技术同学,当然要尝试下它的能力能否胜任日常的编码工作,于是在网上找了一些评测常用的问题,以及根据自己日常研发会遇到的问题进行了一些测试,下面就是评测结果。
155 0
|
JavaScript 数据可视化 前端开发
《面向三维GIS的Cesium开发与应用》读书笔记
《面向三维GIS的Cesium开发与应用》读书笔记
|
监控 测试技术
软件测试培训哪里好?就业前景可观吗?
近些年,由于我国的软件行业目前突破了作坊时代,由以前软件开发的单打独斗升级为工业化、流水线式的生产模式,作为工业化的产品,软件测试也就成为软件开发企业必不可少的质量监控部门,因此这也使得软件测试成为我国就业市场里面最热门的岗位之一,那么这让这么多人首选的软件测试就业前景怎样呢?
124 0
|
安全 数据安全/隐私保护
目前CleanMyMac软件最新版在哪里下载?
目前CleanMyMac软件最新的版本为4.11.4,CleanMyMac就是一款Mac系统清理软件,支持垃圾清理、隐私保护、恶意软件移除、文件清理、应用卸载,功能齐全的同时,软件设置也支持各种自定义。下面小编就利用CLeanMyMac X版本,详解一些这款软件的通用设置,从软件设置的角度,带大家全面的了解以及更好地掌握这一款Mac软件。很多小伙伴说只会用而不会安装软件,以及CleanMyMac的安装下载图解。
114 0
|
Java Android开发
Android 12 编译之坑
Android 12 编译之坑
291 0
Android 12 编译之坑
|
机器学习/深度学习 算法 Java
Apache Flink ML 2.1.0 发布公告
Apache Flink 社区很荣幸地宣布 Apache Flink ML 2.1.0 版本正式发布
Apache Flink ML 2.1.0 发布公告
|
开发工具 git
Git高频命令汇总(下)
Git是一个开源的分布式版本控制软件,用以有效、高速的处理从很小到非常大的项目版本管理。可以说,Git在我们的日常软件开发中,无处不在。我对Git中常见的命令进行了梳理,如下所示。