鍍金池/ 問答/Java  PHP  Android/ apidoc中怎樣才可以使@apiGroup兼容中文?

apidoc中怎樣才可以使@apiGroup兼容中文?

apidoc這個(gè)插件不允許在@apiGroup塊中使用中文,如果帶有中文會(huì)用“__”代替。
想要知道除了在@apiDefine中定義外,還有什么方法能夠使@apiGroup使用中文。

/**
     * @api {post} /api-user/check-code 校驗(yàn)驗(yàn)證碼
     * @apiName checkCode
     * @apiGroup 用戶類(這里使用中文)
     *
     * @apiParam {string} aes 來源
     * @apiParam {string} key 簽名
     * @apiParam {string} token 令牌
     * @apiParam {string} code 驗(yàn)證碼
     * @apiParam {string} type 類型,1.注冊(cè)
     *
     * @apiSuccess {string} error 狀態(tài)碼1.成功、0.失敗
     * @apiSuccess {string} code 錯(cuò)誤碼碼10000.Successful、10005.非法請(qǐng)求、10007.參數(shù)錯(cuò)誤、2001.驗(yàn)證碼過期、2002.驗(yàn)證碼錯(cuò)誤,2003.尚未生成驗(yàn)證碼
     * @apiSuccess {string} msg 返回詳情
     * @apiSuccess {array[]} result 結(jié)果集
     *
     * @apiSuccessExample Success-Response:
     * HTTP/1.1 10000 OK
     * {
     *   "error":"1",
     *   "code":"10000",
     *   "msg":"校驗(yàn)成功",
     *   "result":[
     *
     *   ]
     * }
     */

之前有同事成功地解決了這個(gè)問題,不過他沒做筆記,現(xiàn)在也忘記了原來是怎么解決的。
直接使用中文,這是他的代碼和生成的文檔

/**
     * @api {POST} ?p=apiAgentRecord&a=getMemberList   獲取會(huì)員記錄列表
     * @apiVersion      1.0.0
     * @apiName         getMemberList
     * @apiGroup        用戶類
     * @apiPermission  登錄后
     *
     * @apiDescription  獲取會(huì)員記錄列表
     *
     * @apiParam   {Number}   page                          頁數(shù),默認(rèn)為 1
     * @apiParam   {String}   pageSize                      每頁條數(shù),默認(rèn)為 5
     * @apiParam   {String}   searchData                    關(guān)鍵字,默認(rèn)為''
     *
     * @apiSuccess {Number}   rank_name                     會(huì)員等級(jí)名稱
     * @apiSuccess {String}   user_id                       會(huì)員ID
     * @apiSuccess {String}   mobile                        手機(jī)號(hào)碼
     * @apiSuccess {String}   user_name                     會(huì)員賬號(hào)
     * @apiSuccess {String}   nick_name                     會(huì)員昵稱
     * @apiSuccess {String}   sex                           會(huì)員昵稱性別
     * @apiSuccess {String}   user_rank                     會(huì)員等級(jí)
     * @apiSuccess {String}   rank_changeTime               用戶等級(jí)修改時(shí)間
     * @apiSuccess {String}   MemberTime                    首次購買會(huì)員時(shí)間
     * @apiSuccess {String}   MemberMoney                   首次購買會(huì)籍費(fèi)用
     * @apiSuccess {String}   realname                      真實(shí)姓名
     * @apiSuccess {String}   rank_status                   月份,默認(rèn)為0
     * @apiSuccess {String}   reg_time                      注冊(cè)時(shí)間
     * @apiSuccess {String}   AgentID                       代理ID
     * @apiSuccess {String}   AgentCode                     加盟編碼
     * @apiSuccess {String}   IntroduceUserName             介紹人姓名
     *
     * @apiSuccessExample  {json} Response (success):
     * {
     * ???"status":0,
     * ???"msg":"獲取會(huì)員記錄成功!",
     * ???"data":[
     * ???????{
     * ???????????"rank_name":"男爵會(huì)員",
     * ???????????"user_id":"00002151",
     * ???????????"mobile":"18820698877",
     * ???????????"user_name":"18820698877",
     * ???????????"nick_name":"1882069887",
     * ???????????"sex":"1",
     * ???????????"user_rank":"3",
     * ???????????"rank_changeTime":"1489397095",
     * ???????????"MemberTime":"2017-03-13 17:24:55",
     * ???????????"MemberMoney":"10000.00",
     * ???????????"realname":"鐘今鐸",
     * ???????????"rank_status":"1",
     * ???????????"reg_time":"2016-12-23 14:39:37",
     * ???????????"AgentID":"16",
     * ???????????"AgentCode":"N915",
     * ???????????"IntroduceUserName":""
     * ???????}
     * ???],
     * ???"total":1
     * }
     *
     * @apiErrorExample  {json} Response (error):
     * {
     *??? "status":1,
     *??? "msg":"您暫無會(huì)員會(huì)籍記錄!",
     *?? ?"data":"",
     *? ??"total":0
     * }
     */

clipboard.png

回答
編輯回答
貓館

C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers\api_group.js
注釋掉

//group = group.replace(/[^\w]/g, '_');
2018年3月7日 04:13