Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@apiGroup using Chinese, cannot be resolved properly #470

Closed
imfuxiao opened this issue Apr 25, 2016 · 6 comments
Closed

@apiGroup using Chinese, cannot be resolved properly #470

imfuxiao opened this issue Apr 25, 2016 · 6 comments

Comments

@imfuxiao
Copy link

@APIGroup using Chinese, cannot be resolved properly

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup DM档期信息
*/

Chinese is shown as "____"

@rottmann
Copy link
Member

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

/**
 * @apiDefine theName DM档期信息
 */

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

@imfuxiao
Copy link
Author

Thank you

@ghost
Copy link

ghost commented May 3, 2016

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 : 创建分类

@ghost
Copy link

ghost commented May 3, 2016

@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} 正常:
     * [1]
     */

But not working at all

@rottmann

@rottmann
Copy link
Member

rottmann commented May 3, 2016

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

@mongo-lab
Copy link

Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants