apidoc生成接口文档，分组支持中文命名

最新推荐文章于 2025-07-07 10:02:29 发布
原创 最新推荐文章于 2025-07-07 10:02:29 发布 · 3.1k 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

为解决apidoc处理API文档时对特殊字符的不当替换，本文指导如何找到并编辑api_group.js文件中的指定行，通过注释掉特定代码行，避免组名中的特殊字符被替换为下划线，确保API文档的准确性和专业性。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

找到路径：
C:\Users\当前用户\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers\api_group.js

编辑api_group.js大约83行，把这行代码注释掉就行

group = group.replace(/[^\w]/g, '_');
apidoc在@apiGroup使用中文的方法
GlatChen的专栏
04-16 5937
个人强烈推荐方法1.方法1.C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers\api_group.js，注释掉//group = group.replace(/[^\w]/g, '_');注意：这里的“Administrator”只是我的电脑主机名，...
apiDoc生成接口文档,不费吹灰之力
飞鸿的博客
06-20 658
效果 背景 之前做前端的时候,后端同学仗着自己是老同志,不给我接口文档 苦逼如我,需要拿着笔坐在他的旁边,听他口述 写下需要的api接口url和参数等等 现在自己做后端了,那不能这样子胡作非为了 自己吃的苦,怎能给其他同学吃呢? 这时候,apiDoc你值得拥有,稳稳的输出一篇优质的接口文档 安装apidoc 官网上是全局安装,我是喜欢安装到项目中,这样可以在另一个环境下,npm install就...
apidoc分组中文无法显示问题
一只咸鱼的自我修养
07-06 1507
1.找到api_group.js，一般是在C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers\api_group.js2.注释掉//group = group.replace(/[^\w]/g, '_');
告别Swagger UI！SpringBoot整合SpringDoc OpenAPI：更强大的API文档新选择
最新发布
2503_92695612的博客
07-07 2670
本文简单介绍了Spring环境中整合Swagger替代SpringFox的新方式：SpringDoc
如何为API项目分组？
Eolink 的博客
12-21 751
随着项目的不断发展，我们希望能够将庞大的API系统拆分成多个子系统，并且对API文档和测试进行适当的分类，方便研发管理。我们在 EOLINKER AMS 产品中提供了项目分组的功能，你可以通过它拆分庞大的API项目、并且将拆分之后的项目分组归类。 在项目列表中，点击 新建项目组 按钮，在弹窗中输入项目组的名称并保存。 接着我们可以点击 批量操作 按钮，选择需要归类的项目，然后点击 移动 按钮，将...
Web API文档生成工具apidoc
- PERSIST °
04-27 2345
详情请看转载http://www.jianshu.com/p/bb5a4f5e588a window下安装http://www.bubuko.com/infodetail-948579.html 在要生成的项目下创建 apidoc.json { "name" : "APP接口", "version": "1.0.0", "title": "APP接口", "de
自动生成接口文档的神器---＜apidoc＞
奇点的博客
09-28 1067
自动生成接口文档的神器---
推荐几款在线管理APIdoc接口文档管理的网站,无需本地搭建环境,免费注册后即可使用.zip
01-07
在IT行业中，API（应用程序编程接口）文档管理是软件开发过程中的重要环节，它帮助团队协同工作，确保接口设计清晰，提高开发效率。随着云计算的发展，越来越多的在线工具应运而生，使得开发者无需在本地搭建环境就...
Gulp-apidoc工具：简化RESTful API文档自动生成
资源摘要信息:"gulp-apidoc是一个用于自动生成RESTful Web API文档的工具，它允许开发者通过简单的注释来描述API接口。该工具已经不再被官方支持，因此建议改用apidoc，这是同一个开发团队提供的更新版本。不过，...
JavaDoc【注释】生成API（开发文档）详解
kertnudserf56968的博客
02-13 2353
Javadoc 是 Java 自带的一种工具，其可以从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。
laravel-apidoc-generator, Laravel API文档生成器.zip
09-17
laravel-apidoc-generator, Laravel API文档生成器 Laravel API文档生成器自动从现有的Laravel 路由生成你的API文档。 让我们看一下示例文档。php artisan api:gen --routePrefix="settings/api/*"
apiDoc使用指南
weixin_43395106的博客
09-17 837
apiDoc使用指南： 安装： 1: 需要先安装node.js(安装node.js请浏览相关博客) 2: node.js安装完成后使用命令: npm install apidoc -g 配置： 在你的项目根路径下新建apidoc.json文件,该文件描述了项目对外提供接口的概要信息如名称,版本,描述文档打开时浏览器显示标题和接口缺省访问地址. 使用样例： /** * * @apiDefine RkNotFoundException * * @apiError RkNotFoundExceptio
apidoc @apiGroup兼容中文
weixin_30820077的博客
07-24 273
1.找到安装目录 中 api_group.jscentos安装目录：/usr/lib/node_modules/apidoc/node_modules/apidoc-core/lib/workers/api_group.jswindow安装目录：C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modu...
apidoc的使用和常见问题的解决办法
small_33的博客
08-15 9224
珊妹子刚入职新公司就接触到apidoc这个生成接口文档的技术，刚刚学习的时候，它本身是有手册的，但是也是就介绍安装和语法，实际遇到的问题，还得自己来抠，这个apidoc是通过后台写接口的注释来达到自动生成接口文档的作用。 apidoc是基于node使用的，所以具体安装方法请参考：https://www.cnblogs.com/minsons/articles/7154090.html 安装和使...
apidoc生成的接口文档页面布局混乱解决办法
ww305456036的博客
02-27 702
之前一直使用apidoc生成接口文档，今天因为在另一台电脑上也需要使用，就按照网上的教程安装了nodejs和apidoc。但是安装成功之后，执行apidoc命令生成接口文档的页面布局居然是混乱的，或者说跟以前不太一样。具体是这样的： 再看生成的具体代码如下： 可见好像是少了一些什么东西。然后从网上各种查资料，将nodejs和apidoc卸载重装了多次仍然无果。 后来突然想到，是不是apidoc官方更新了？难道官方的布局就更新成这样了吗？ 抱着这个想法，找到了apidoc的官方网址，如下：
apidoc接口文档生成工具的使用
qq_46093208的博客
02-16 387
关于apidoc接口文档生成工具的使用 3.使用样例 @api @apiVersion @apiName @apiGroup @apiParam @apiSuccess @apiError __apiSuccessExample 样例 4.生成接口文档 找到输出目录下的index.html文件,打开即可查看接口文档
apidoc的介绍和使用
热门推荐
lvbaolin123的博客
09-26 2万+
apidoc是使用编写接口文档非常方便的，一种编写
apiDoc 详解 api接口文档生成
努力的Dom先生
02-20 2万+
PHP使用apiDoc api接口文档安装apidocapidoc 命令参数列表配置(apidoc.json)apidoc.json配置项apidoc注释参数@api@apiErrorExample@apiDefine@apiDeprecated@apiDescription@apiError@apiExample@apiGroup@apiParam@apiHeader@apiHeaderExam...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

每天都进步一点点

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值