Apidoc: @apiBody ๋ฐ @apiQuery๊ฐ€ ๋ Œ๋”๋ง๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

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

๋ฒ„๊ทธ ์„ค๋ช…

๋‚ด apiDoc์— ๋Œ€ํ•œ ์ฟผ๋ฆฌ ๋ฐ ๋ณธ๋ฌธ ๋งค๊ฐœ๋ณ€์ˆ˜๋ฅผ ์ž‘์„ฑํ•˜๋ ค๊ณ  ํ•˜์ง€๋งŒ @apiBody ๋ฐ @apiQuery ๋ชจ๋‘ ๋ธŒ๋ผ์šฐ์ €์—์„œ ์—ด ๋•Œ index.html ํŒŒ์ผ์— ํ‘œ์‹œ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

apiDoc์„ ์‹คํ–‰ํ•˜๊ณ  ๋ฌธ์„œ๋ฅผ ์ƒ์„ฑํ–ˆ์œผ๋ฉฐ ๋‚˜๋จธ์ง€๋Š” ์ž˜ ์ž‘๋™ํ•ฉ๋‹ˆ๋‹ค. ๊ทธ ๋‘˜๋งŒ ๋‚˜ํƒ€๋‚˜์ง€ ์•Š๋Š”๋‹ค.

์žฌํ˜„ ๋‹จ๊ณ„

/**
 * 
 * <strong i="12">@api</strong> {POST} /auth/signUp signUp
 * <strong i="13">@apiGroup</strong> auth
 * <strong i="14">@apiVersion</strong>  0.1.0
 * 
 * 
 * <strong i="15">@apiQuery</strong> {Number} id Users unique ID.
 * 
 * <strong i="16">@apiBody</strong> {Number} id Users unique ID.
 * 
 */
  • apidoc ๋ฒ„์ „: 0.27.1
  • ์šด์˜ ์ฒด์ œ: ์šฐ๋ถ„ํˆฌ 20.04
  • ๋ธŒ๋ผ์šฐ์ € : ๋ธŒ๋ ˆ์ด๋ธŒ, ํŒŒ์ด์–ดํญ์Šค

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

์ด์— ๋Œ€ํ•œ ํ•ด๊ฒฐ ๋ฐฉ๋ฒ•์ด ์žˆ์Šต๋‹ˆ๋‹ค. ๋Œ€์‹  ์ด๊ฒƒ์„ ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

..
..
..
<strong i="6">@apiParam</strong> (Query) {Number} id Users unique ID. // instead of <strong i="7">@apiQuery</strong> ...

<strong i="8">@apiParam</strong> (Body) {Number} id Users unique ID. // instead of <strong i="9">@apiBody</strong> ...

์ด๊ฒƒ์€ ์›น์‚ฌ์ดํŠธ์— ๋ช…์‹œ๋œ <strong i="12">@apiQuery</strong> {Number} id Users unique ID. ์™€ ๋‹ฌ๋ฆฌ apidocjs.com ํŽ˜์ด์ง€์— ์ž‘์„ฑ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๊ทธ๋ž˜์„œ ์ด๊ฒƒ์ด ์ด๊ฒƒ์„ ์“ฐ๋Š” ์˜๋„๋œ ๋ฐฉ๋ฒ•์ธ์ง€ ํ™•์‹คํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

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

์ด์— ๋Œ€ํ•œ ํ•ด๊ฒฐ ๋ฐฉ๋ฒ•์ด ์žˆ์Šต๋‹ˆ๋‹ค. ๋Œ€์‹  ์ด๊ฒƒ์„ ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

..
..
..
<strong i="6">@apiParam</strong> (Query) {Number} id Users unique ID. // instead of <strong i="7">@apiQuery</strong> ...

<strong i="8">@apiParam</strong> (Body) {Number} id Users unique ID. // instead of <strong i="9">@apiBody</strong> ...

์ด๊ฒƒ์€ ์›น์‚ฌ์ดํŠธ์— ๋ช…์‹œ๋œ <strong i="12">@apiQuery</strong> {Number} id Users unique ID. ์™€ ๋‹ฌ๋ฆฌ apidocjs.com ํŽ˜์ด์ง€์— ์ž‘์„ฑ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๊ทธ๋ž˜์„œ ์ด๊ฒƒ์ด ์ด๊ฒƒ์„ ์“ฐ๋Š” ์˜๋„๋œ ๋ฐฉ๋ฒ•์ธ์ง€ ํ™•์‹คํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

๋‚˜์™€ ๊ฐ™์€ ๋ฌธ์ œ. @apiBody ๊ฐ€ ์ž‘๋™ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. Btw, ์ž‘์—…์— ๋Œ€ํ•ด @Abdelrhman-Hosny์—๊ฒŒ ๊ฐ์‚ฌ๋“œ๋ฆฝ๋‹ˆ๋‹ค.

์ด ๋ฌธ์ œ๋Š” ๋‚ด ๋ฌธ์ œ #952์™€ ์ค‘๋ณต๋ฉ๋‹ˆ๋‹ค.

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