Apidoc: @apiGroup using Chinese, cannot be resolved properly

Created on 25 Apr 2016  路  6Comments  路  Source: apidoc/apidoc

@apiGroup using Chinese, cannot be resolved properly

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup DM妗f湡淇℃伅
*/

Chinese is shown as "____"

Most helpful comment

Not directly supported.
To show a Group name you can use define

/**
 * @apiDefine theName DM妗f湡淇℃伅
 */

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup theName
*/

All 6 comments

Not directly supported.
To show a Group name you can use define

/**
 * @apiDefine theName DM妗f湡淇℃伅
 */

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup theName
*/

Thank you

But the url link not working

http://www.demo.com/#api-GroupBooks-____

The chinse words not include in the url anchor, so we can not navigate to the right section of the document

The part of the anchor which in chinese words all gone to _____

And the real chinese words : 鍒涘缓鍒嗙被

@apiName can not using chinese words also. and can not using @apiDefine to define a chinese words as apiName

I tried to define it

 /**
     * @apiDefine BooksSyncWrite 鏇存柊璐︽湰
     * @api {post} /apiv1/books/syncwrite 鏇存柊璐︽湰
     * @apiName BooksSyncWrite
     * @apiGroup GroupBooks
     *
     * @apiParam {String} bookid 璐︽湰ID
     * @apiParam {Integer} roleid 瑙掕壊ID
     * @apiParam {Integer} uid 鐢ㄦ埛UID
     *
     * @apiSuccessExample {json} 姝e父:
     * [1]
     */

But not working at all

@rottmann

Define must be in a separate /** */ block.

Thank you

Was this page helpful?
0 / 5 - 0 ratings