Apidoc: ์ค‘๊ตญ์–ด๋กœ ๋œ apiName ๋ฐ apiGroup ์ธ์ฝ”๋”ฉ ์˜ค๋ฅ˜

์— ๋งŒ๋“  2016๋…„ 03์›” 11์ผ  ยท  3์ฝ”๋ฉ˜ํŠธ  ยท  ์ถœ์ฒ˜: apidoc/apidoc

/**
 * <strong i="5">@api</strong> {get} /user/:id     api่Žทๅ–็”จๆˆทไฟกๆฏ
 * <strong i="6">@apiName</strong>                 apiName่Žทๅ–็”จๆˆทไฟกๆฏ
 * <strong i="7">@apiGroup</strong>                apiGroupๅˆ†็ป„
 * <strong i="8">@apiDescription</strong>          descriptionๆ่ฟฐไฟกๆฏ
 */

------ api_data.json -------
{
"์œ ํ˜•": "๊ฐ€์ ธ์˜ค๊ธฐ",
"URL": "/์‚ฌ์šฉ์ž/:ID",
"์ œ๋ชฉ": "api่Žทๅ–็”จๆˆทไฟกๆฏ",
"์ด๋ฆ„": "apiName______",
"๊ทธ๋ฃน": "apiGroup__",
"์„ค๋ช…": "์„ค๋ช…ๆ่ฟฐไฟกๆฏ"
}

apiName ๋ฐ apiGroup ์ธ์ฝ”๋”ฉ ์˜ค๋ฅ˜๊ฐ€ ์ค‘๊ตญ์–ด๋กœ ํ‘œ์‹œ๋˜์ง€๋งŒ ์ œ๋ชฉ๊ณผ ์„ค๋ช…์€ ๋งž์Šต๋‹ˆ๋‹ค.
apidoc ๋ฒ„์ „์€ 0.15.1์ž…๋‹ˆ๋‹ค.

๊ฐ€์žฅ ์œ ์šฉํ•œ ๋Œ“๊ธ€

์•„๋ž˜ ์ž‘์—…์„ ์ˆ˜ํ–‰ํ•œ ํ›„ Apidoc์€ ์ค‘๊ตญ์–ด๋ฅผ ์ง€์›ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

node_modules/apidoc-core/lib/workers/api_group.js

๊ทธ๋ฃน = group.replace(/[^\w]/g, '_'); --> ๊ทธ๋ฃน = group.replace(/[^\w\u4E00-\u9FA5]/g, '_');

api_name.js

์ด๋ฆ„ = name.replace(/[^\w]/g, '_'); --> ์ด๋ฆ„ = name.replace(/[^\w\u4E00-\u9FA5]/g, '_');

ํ•˜์ง€๋งŒ ์ˆ˜๋™์œผ๋กœ ํ•˜๋ฉด ๋ณ„๋กœ ๋ถˆํŽธํ•˜์ง€ ์•Š์œผ๋‹ˆ ์ž˜ ์ƒ๊ฐํ•ด๋ณด์‹œ๊ณ  ํŒจํ‚ค์ง€ ์—…๋ฐ์ดํŠธ ํ•ด์ฃผ์‹œ๋ฉด ๊ฐ์‚ฌํ•˜๊ฒ ์Šต๋‹ˆ๋‹ค.

๋ชจ๋“  3 ๋Œ“๊ธ€

์•ˆ๋…•ํ•˜์„ธ์š”. ์ €๋„ ์ค‘๊ตญ์–ด๋ฅผ ์‚ฌ์šฉํ•˜๋Š”๋ฐ ๋ฌธ์ œ๋Š” ์—†์Šต๋‹ˆ๋‹ค๋งŒ ๋˜ ๋‹ค๋ฅธ ๋ฌธ์ œ๊ฐ€ ๋ฐœ์ƒํ•˜์—ฌ @api ๊ฒฝ๋กœ๋„ ํ‘œ์‹œ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๋‚ด ๋ฌธ์ œ ๋ณด๊ธฐ

ํ˜„์žฌ ์œ ๋‹ˆ์ฝ”๋“œ๋Š” ์ง€์›๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

์•„๋ž˜ ์ž‘์—…์„ ์ˆ˜ํ–‰ํ•œ ํ›„ Apidoc์€ ์ค‘๊ตญ์–ด๋ฅผ ์ง€์›ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

node_modules/apidoc-core/lib/workers/api_group.js

๊ทธ๋ฃน = group.replace(/[^\w]/g, '_'); --> ๊ทธ๋ฃน = group.replace(/[^\w\u4E00-\u9FA5]/g, '_');

api_name.js

์ด๋ฆ„ = name.replace(/[^\w]/g, '_'); --> ์ด๋ฆ„ = name.replace(/[^\w\u4E00-\u9FA5]/g, '_');

ํ•˜์ง€๋งŒ ์ˆ˜๋™์œผ๋กœ ํ•˜๋ฉด ๋ณ„๋กœ ๋ถˆํŽธํ•˜์ง€ ์•Š์œผ๋‹ˆ ์ž˜ ์ƒ๊ฐํ•ด๋ณด์‹œ๊ณ  ํŒจํ‚ค์ง€ ์—…๋ฐ์ดํŠธ ํ•ด์ฃผ์‹œ๋ฉด ๊ฐ์‚ฌํ•˜๊ฒ ์Šต๋‹ˆ๋‹ค.

์ด ํŽ˜์ด์ง€๊ฐ€ ๋„์›€์ด ๋˜์—ˆ๋‚˜์š”?
0 / 5 - 0 ๋“ฑ๊ธ‰