apidoc笔记

1 篇文章 0 订阅
1 篇文章 0 订阅

1.除安装node.js之外,还需使用npm install apidoc –g命令安装插件;

2.为了让api的标题可以显示为中文,参考了一些资料,总结如下: 

找到安装目录 中 api_group.js,下方是我的目录,可以参考:

C:\Users\ZhiJiao361\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers\api_group.js

 注释代码:

group = group.replace(/[^\w]/g, '_');

完成。

3.apidoc文档注释完成后,执行以下命令,将静态页生成到dest目录:

apidoc -i net/lhcredit/interfacelayer/main/v1_1/apidoc -o dest

注意路径

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
APIDOC是一个用于生成RESTful API文档的工具,它可以从代码注释中提取特定格式的内容生成文档。它支持多种开发语言,如GO、Java、C、Rust等。使用APIDOC可以方便地为后端代码编写接口文档,并且可以自动生成文档。在Node.js项目中使用APIDOC,你需要新建一个文件夹来存放生成的文档,并在项目的启动文件(如app.js)中添加相应的配置,示例代码如下:app.use('/apidoc存放的位置',express.static('apidoc存放的位置'));其中,'apidoc存放的位置'是你存放APIDOC生成的文件的路径,通过访问相应的URL地址,即可自动运行生成的API文档。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [Node与apidoc的邂逅——NodeJS Restful 的API文档生成](https://blog.csdn.net/weixin_33953249/article/details/93345878)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* *3* [APIDOC- API文档生成工具——node](https://blog.csdn.net/mantou_riji/article/details/125697962)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值