๋ด 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.
*
*/
์ด์ ๋ํ ํด๊ฒฐ ๋ฐฉ๋ฒ์ด ์์ต๋๋ค. ๋์ ์ด๊ฒ์ ์์ฑํ ์ ์์ต๋๋ค.
..
..
..
<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์ ์ค๋ณต๋ฉ๋๋ค.
๊ฐ์ฅ ์ ์ฉํ ๋๊ธ
์ด์ ๋ํ ํด๊ฒฐ ๋ฐฉ๋ฒ์ด ์์ต๋๋ค. ๋์ ์ด๊ฒ์ ์์ฑํ ์ ์์ต๋๋ค.
์ด๊ฒ์ ์น์ฌ์ดํธ์ ๋ช ์๋
<strong i="12">@apiQuery</strong> {Number} id Users unique ID.
์ ๋ฌ๋ฆฌ apidocjs.com ํ์ด์ง์ ์์ฑ๋์ง ์์ต๋๋ค. ๊ทธ๋์ ์ด๊ฒ์ด ์ด๊ฒ์ ์ฐ๋ ์๋๋ ๋ฐฉ๋ฒ์ธ์ง ํ์คํ์ง ์์ต๋๋ค.