Apidoc: ๋ฐฐ์—ด์ด ์žˆ๋Š” ์š”์ฒญ ๋ณธ๋ฌธ

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

์•ˆ๋…•!

์ด๊ฒƒ์„ ์–ด๋–ป๊ฒŒ ๋ฌธ์„œํ™”ํ• ๊นŒ์š”?

POST /batch-insert
[
  { "name": "Name 1" },
  { "name": "Name 2" }
]

@apiParam ๋Š” ์š”์ฒญ ๋ณธ๋ฌธ์„ ๋ฌธ์„œํ™”ํ•˜๋Š” ๋ฐ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์ง€๋งŒ <strong i="10">@apiParam</strong> {String[]} name ๋Š” { "name": ["Name 1", "Name 2"] } $๋ฅผ ์•”์‹œํ•œ๋‹ค๋Š” ๊ฒƒ์„ ์ดํ•ดํ•ฉ๋‹ˆ๋‹ค.

enhancement

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

@kok-ng ์„ค๋ช…ํ•˜๋Š” ๊ฒƒ์€ ๋‹ค๋ฅธ API์ž…๋‹ˆ๋‹ค. ์ •์˜ํ•œ ๋ฌธ์„œ๋Š” ๋‹ค์Œ ์š”์ฒญ์„ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค.

{
    names: [{ "name": "Name 1" }, { "name": "Name 2" }] 
}

๊ทธ๋Ÿฌ๋‚˜ @Znarkus ๊ฐ€ ์š”๊ตฌํ•œ ๊ฒƒ๊ณผ ๋‚ด๊ฐ€ ๋˜ํ•œ ์ฐพ๊ณ  ์žˆ๋Š” ๊ฒƒ์€ ๋‹ค์Œ๊ณผ ๊ฐ™์€ API๋ฅผ ๋ฌธ์„œํ™”ํ•˜๋Š” ๋ฐฉ๋ฒ•์ž…๋‹ˆ๋‹ค.

 [{ "name": "Name 1" }, { "name": "Name 2" }]

์ถ”์‹ : ์ด๋Š” ๊ฐ ๋์ ์— ๋Œ€ํ•œ ์–‘์‹์„ ์ƒ์„ฑํ•˜๋Š” APIDoc ๊ธฐ๋Šฅ์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ ํŠนํžˆ ๊ด€๋ จ์ด ์žˆ์Šต๋‹ˆ๋‹ค. ํ˜„์žฌ ๋์ ์ด ๋ช…๋ช…๋œ ๋งค๊ฐœ ๋ณ€์ˆ˜๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ์•Š๋Š” ํ•œ(์ฆ‰, ๋ฐฐ์—ด์ด ์•„๋‹Œ ๊ฐœ์ฒด๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ์•Š๋Š” ํ•œ) ๋์ ์— ๋Œ€ํ•œ ์–‘์‹์„ ์ƒ์„ฑํ•˜๋„๋ก APIDoc์„ ๊ฐ€์ ธ์˜ค๋Š” ๊ฒƒ์€ ๋ถˆ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

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

๋‚˜๋Š” ๋„ˆ์˜ ๊ณ ํ†ต์„ ๋Š๋‚€๋‹ค.
์†”๋ฃจ์…˜์ด ๊ตฌํ˜„๋˜์ง€ ์•Š์€ ๋™์•ˆ ๋ฐ‘์ค„์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
* <strong i="7">@apiParam</strong> {Object[]} _ array of objects with:

๊ทธ๊ฒƒ์€ API๋ฅผ ์ถฉ๋ถ„ํžˆ ์ฝ์„ ์ˆ˜ ์žˆ๋„๋ก ์œ ์ง€ํ•ฉ๋‹ˆ๋‹ค ...

@dfreire _์€(๋Š”) ๋ฌด์—‡์„ ํ•˜๋‚˜์š”?

์•„๋ฌด๊ฒƒ๋„. ๋ฌธ์„œ ์ถœ๋ ฅ์—์„œ โ€‹โ€‹์ฝ๊ธฐ ์‰ฌ์šด ์ž๋ฆฌ ํ‘œ์‹œ์ž์ผ ๋ฟ์ž…๋‹ˆ๋‹ค.

์•ˆ๋…•,
๋‹ค์Œ๊ณผ ๊ฐ™์€ ๊ฒƒ์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ

 * <strong i="7">@apiParam</strong> {Object[]} [names] A serie of names
 * <strong i="8">@apiParam</strong> {Object} [names.name] A name

๋งค์šฐ ๋ช…ํ™•ํ•˜๊ณ  ๋“ค์—ฌ์“ฐ๊ธฐ๋œ ๋ฌธ์„œ๋ฅผ ์ถœ๋ ฅํ•˜์ง€๋งŒ apiSampleUrl์„ ์‚ฌ์šฉํ•˜์—ฌ ์˜ฌ๋ฐ”๋ฅด๊ฒŒ ์ „์†กํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

@kok-ng ์„ค๋ช…ํ•˜๋Š” ๊ฒƒ์€ ๋‹ค๋ฅธ API์ž…๋‹ˆ๋‹ค. ์ •์˜ํ•œ ๋ฌธ์„œ๋Š” ๋‹ค์Œ ์š”์ฒญ์„ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค.

{
    names: [{ "name": "Name 1" }, { "name": "Name 2" }] 
}

๊ทธ๋Ÿฌ๋‚˜ @Znarkus ๊ฐ€ ์š”๊ตฌํ•œ ๊ฒƒ๊ณผ ๋‚ด๊ฐ€ ๋˜ํ•œ ์ฐพ๊ณ  ์žˆ๋Š” ๊ฒƒ์€ ๋‹ค์Œ๊ณผ ๊ฐ™์€ API๋ฅผ ๋ฌธ์„œํ™”ํ•˜๋Š” ๋ฐฉ๋ฒ•์ž…๋‹ˆ๋‹ค.

 [{ "name": "Name 1" }, { "name": "Name 2" }]

์ถ”์‹ : ์ด๋Š” ๊ฐ ๋์ ์— ๋Œ€ํ•œ ์–‘์‹์„ ์ƒ์„ฑํ•˜๋Š” APIDoc ๊ธฐ๋Šฅ์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ ํŠนํžˆ ๊ด€๋ จ์ด ์žˆ์Šต๋‹ˆ๋‹ค. ํ˜„์žฌ ๋์ ์ด ๋ช…๋ช…๋œ ๋งค๊ฐœ ๋ณ€์ˆ˜๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ์•Š๋Š” ํ•œ(์ฆ‰, ๋ฐฐ์—ด์ด ์•„๋‹Œ ๊ฐœ์ฒด๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ์•Š๋Š” ํ•œ) ๋์ ์— ๋Œ€ํ•œ ์–‘์‹์„ ์ƒ์„ฑํ•˜๋„๋ก APIDoc์„ ๊ฐ€์ ธ์˜ค๋Š” ๊ฒƒ์€ ๋ถˆ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

์ด๊ฒƒ์— ๋Œ€ํ•œ ์—…๋ฐ์ดํŠธ๊ฐ€ ์žˆ์Šต๋‹ˆ๊นŒ?

@fedemengo ์•„๋‹ˆ์š”, ํ•˜์ง€๋งŒ ๊ธฐ์—ฌ๋ฅผ ํ™˜์˜ํ•ฉ๋‹ˆ๋‹ค! ;)

์ตœ๊ทผ์—๋Š” ๊ณต๊ฐœ๋œ PR/์ด์Šˆ์˜ ์ˆ˜๋ฅผ ์ค„์ด๋Š” ๋ฐ ๋งŽ์€ ๋…ธ๋ ฅ์„ ๊ธฐ์šธ์ด๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ์ด ๋ฌธ์ œ๋Š” ๊ฒฐ๊ตญ ํ•ด๊ฒฐ๋  ๊ฒƒ์ž…๋‹ˆ๋‹ค. ํ˜„์žฌ ๋ฒ„๊ทธ๊ฐ€ ์•„๋‹Œ ๋ฌธ์ œ๋Š” ์šฐ์„  ์ˆœ์œ„๊ฐ€ ๋‚ฎ์Šต๋‹ˆ๋‹ค.

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