首页 > 其他分享 >在宝塔下使用apidoc

在宝塔下使用apidoc

时间:2024-09-01 11:47:57浏览次数:13  
标签:宝塔 商家 目录 api 文档 使用 apidoc id

1.先安装ndoe版本管理器 安装node的v14版本

如果回到系统命令行下输入node命令无法使用,则需要选择命令行版本

 

2.在命令行下安装apidoc:

npm install apidoc -g 

安装完后如果发现apidoc命令无法使用,则需要建立软连接:

ln -s /www/server/nodejs/v14.17.6/bin/apidoc /usr/bin/apidoc

3.创建api.json配置文件:

{
  "name": "My Project",
  "title": "My API",
  "description":"API接口文档",
  "url" : "http://api.demo.com",
  "version": "0.1.0"
}

4.新建目录src,创建api文档demo:

/**
 * @api {get} /shop/getList/:id 通过商家id获取店铺列表
 * @apiGroup Shop
 *
 * @apiParam (params) {int} id      商家id
 * @apiParamExample 请求参数Demo:
 *      {
 *        "id": 2,
 *       }
 *
 * @apiSuccess {Array} article 返回相应id的文章信息
 *
 * @apiSuccessExample Success-Response:
 *    HTTP/1.1 200 OK
 *      {
 *        "tile": "文章标题2",
 *        "date": 1483941498230,
 *        "author": "classlfz",
 *        "content": "文章的详细内容"
 *       }
 *
 * @apiSampleRequest http://51.133.54.142
 */

/**
 * @api {post} /shop/add 新增商家
 * @apiGroup Shop
 *
 * @apiBody {String} name      商家名
 * @apiBody {String} address      商家地址
 *
 * @apiSuccessExample Success-Response:
 *    HTTP/1.1 200 OK
 *      {
 *        "tile": "文章标题2",
 *        "date": 1483941498230,
 *        "author": "classlfz",
 *        "content": "文章的详细内容"
 *       }
 *
 * @apiSampleRequest http://51.133.54.142
 */

5.新建文档输出目录:doc

现在的目录结构是这样的:

 6.使用命令生成文档:

apidoc -c apidoc.json

 

去doc目录下查看:

 代表生成成功,如果没生成成功,则需要检查src目录下的php文件,检查生成文档。

最终效果:

 

标签:宝塔,商家,目录,api,文档,使用,apidoc,id
From: https://www.cnblogs.com/cx850116/p/18391152

相关文章

  • 使用 nuxi clean 命令清理 Nuxt 项目
    title:使用nuxiclean命令清理Nuxt项目date:2024/9/1updated:2024/9/1author:cmdragonexcerpt:nuxiclean命令是管理和维护Nuxt项目的重要工具,它帮助你快速清理生成的文件和缓存,确保开发环境的干净。通过定期使用这个命令,你可以避免由于缓存或生成文件导致的构......
  • WPF Material Design中资源的查找和使用
    MaterialDesign中,一共分为两大块。一个是颜色资源,一个是控件资源。下面来说下,如何使用控件资源:在VS中,通过Nuget添加完MaterialDesign后,还需要在App.xaml中引用这些资源,引用的方法如下图所示:在1处,引入materialdesign的引用。在2处,可以修改项目的主题色,这个比较重要。以前......
  • 240722 knn 使用皮尔逊找到相似用户
    importjsonimportnumpyasnp#计算皮尔逊系数defpearson_score(dataset,user1,user2):ifuser1notindataset:raiseTypeError('User'+user1+'notpresentinthedataset')ifuser2notindataset:raiseType......
  • Linux实时查看GPU (NVIDIA),CPU及内存使用情况
    GPU方法一:需要用到一个工具gpustatpipinstallgpustat#安装工具gpustat-cp#输出当前状态gpustat-cp-i1#持续监视方法二:使用nvidia-smi命令nvidia-smi-lsecondsnvidia-smi--loop=seconds上述两个命令都可以,要把seconds换成你想刷新的时间间隔。按......
  • 处理springboot使用fastJson浏览器调用接口正常返回数据却中文乱码的问题
    处理springboot使用fastJson浏览器调用接口正常返回数据却中文乱码的问题这属于fastJson的一个bug只需要像下面这样操作就可以了@Bean//使用Bean入fastJsonHttpllessageConvertpublicHttpMessageConverterfastJsonHttpMessageConverters(){//需婴定义......
  • Linux命令fuser使用
    简介在Linux操作系统中,fuser是一个命令行工具,用于查找并显示使用指定文件、文件系统或套接字的进程的情况。它可以帮助我们找出哪些进程占用了某个文件或目录,以便我们能够进行相关操作,比如杀死这些进程或释放对应的资源。命令语法fuser命令的基本语法如下:fuser[选项]文件或目录......
  • MySQL的索引原理及使用
    MySQL中的索引模型Mysql中的索引使用的数据结构一般为搜索树,这里的搜索树,一般使用B树,这里补一下数据结构中的B树结构;说B树之前,先顺一个前置的知识点,平衡二叉树;平衡二叉树二叉树应该都不陌生,大学数据结构的基本入门,二叉排序树是基于二叉树上多了个“有序”的概念,简单来说,即左<......
  • 通过阅读本篇文章你将了解到:CompletableFuture的使用
    通过阅读本篇文章你将了解到:CompletableFuture的使用CompletableFure异步和同步的性能测试已经有了Future为什么仍需要在JDK1.8中引入CompletableFutureCompletableFuture的应用场景对CompletableFuture的使用优化场景说明查询所有商店某个商品的价格并返回,并且查询商店某......
  • 实现UDP可靠性传输(KCP介绍使用)
    1、TCP协议介绍TCP协议是基于IP协议,面向连接,可靠基于字节流的传输层协议1、基于IP协议:TCP协议是基于IP协议之上传输的,TCP协议报文中的源端口+IP协议报文中的源地址+TCP协议报文中的目标端口+IP协议报文中的目标地址,组合起来唯一确定一条TCP连接。2、面向连接:与UDP不同,TCP在传输数......
  • c++ STL常用容器使用(vector、deque、stack、queue、list、set、map等)
    1、vector使用动态数组,也叫可变数组,容器的空间是动态增长的,当空间不足时,申请更大一块空间,让后将原数据拷贝到新空间中,并释放原空间在这里插入图片描述1.1、初始化操作intarr[]={1,3,2,5};//1、方式一(初始化)vector<int>v1;//容器尾部插入数据v1.push_back(1);v1......