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


相关文章
成功解决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
|
5月前
|
网络协议 网络安全 网络架构
TCP连接的保持活跃机制详解
总的来说,TCP的保持活跃机制是网络通信中不可或缺的一部分,能够有效维持TCP连接的活跃性,提高网络性能,防止不必要的网络断开。这一点不论对于TCP协议的深度理解,还是对于网络通信的实际应用,都有着重要的现实意义。
151 17
|
Java 网络安全 Nacos
nacos注册不上刷这个错,有解决方案吗?
【2月更文挑战第30天】nacos注册不上刷这个错,有解决方案吗? springboot项目,瘦身打包后,用java -jar 外置依赖和外置配置文件启动的时候,nacos注册不上刷这个错,有解决方案吗? com.alibaba.nacos.api.exception.NacosException: Client not connected, current status:STARTING
791 1
|
9月前
|
JavaScript Java 程序员
SpringBoot自动配置及自定义Starter
Java程序员依赖Spring框架简化开发,但复杂的配置文件增加了负担。SpringBoot以“约定大于配置”理念简化了这一过程,通过引入各种Starter并加载默认配置,几乎做到开箱即用。
335 10
SpringBoot自动配置及自定义Starter
|
缓存 应用服务中间件 nginx
[nginx]lua控制响应头
[nginx]lua控制响应头
292 0
|
NoSQL Redis Windows
Windows设置Redis服务使其开机自启
Windows设置Redis服务使其开机自启
904 0
idea 2020.2及2020.3版本的安装和激活
idea 2020.2及2020.3版本的安装和激活
8087 3
|
缓存 安全 应用服务中间件
Nginx:关于实现跨域代理
Nginx:关于实现跨域代理
1748 1
|
Java API 区块链
如何在Java中实现智能合约与区块链集成
如何在Java中实现智能合约与区块链集成