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
* }
*/
北大青鳥APTECH成立于1999年。依托北京大學(xué)優(yōu)質(zhì)雄厚的教育資源和背景,秉承“教育改變生活”的發(fā)展理念,致力于培養(yǎng)中國IT技能型緊缺人才,是大數(shù)據(jù)專業(yè)的國家
北大青鳥中博軟件學(xué)院創(chuàng)立于2003年,作為華東區(qū)著名互聯(lián)網(wǎng)學(xué)院和江蘇省首批服務(wù)外包人才培訓(xùn)基地,中博成功培育了近30000名軟件工程師走向高薪崗位,合作企業(yè)超4
中公教育集團(tuán)創(chuàng)建于1999年,經(jīng)過二十年潛心發(fā)展,已由一家北大畢業(yè)生自主創(chuàng)業(yè)的信息技術(shù)與教育服務(wù)機(jī)構(gòu),發(fā)展為教育服務(wù)業(yè)的綜合性企業(yè)集團(tuán),成為集合面授教學(xué)培訓(xùn)、網(wǎng)
達(dá)內(nèi)教育集團(tuán)成立于2002年,是一家由留學(xué)海歸創(chuàng)辦的高端職業(yè)教育培訓(xùn)機(jī)構(gòu),是中國一站式人才培養(yǎng)平臺(tái)、一站式人才輸送平臺(tái)。2014年4月3日在美國成功上市,融資1
浪潮集團(tuán)項(xiàng)目經(jīng)理。精通Java與.NET 技術(shù), 熟練的跨平臺(tái)面向?qū)ο箝_發(fā)經(jīng)驗(yàn),技術(shù)功底深厚。 授課風(fēng)格 授課風(fēng)格清新自然、條理清晰、主次分明、重點(diǎn)難點(diǎn)突出、引人入勝。
曾工作于聯(lián)想擔(dān)任系統(tǒng)開發(fā)工程師,曾在博彥科技股份有限公司擔(dān)任項(xiàng)目經(jīng)理從事移動(dòng)互聯(lián)網(wǎng)管理及研發(fā)工作,曾創(chuàng)辦藍(lán)懿科技有限責(zé)任公司從事總經(jīng)理職務(wù)負(fù)責(zé)iOS教學(xué)及管理工作。
精通HTML5和CSS3;Javascript及主流js庫,具有快速界面開發(fā)的能力,對(duì)瀏覽器兼容性、前端性能優(yōu)化等有深入理解。精通網(wǎng)頁制作和網(wǎng)頁游戲開發(fā)。
具有10 年的Java 企業(yè)應(yīng)用開發(fā)經(jīng)驗(yàn)。曾經(jīng)歷任德國Software AG 技術(shù)顧問,美國Dachieve 系統(tǒng)架構(gòu)師,美國AngelEngineers Inc. 系統(tǒng)架構(gòu)師。