๋ฏธ๋‹ˆ ํ”„๋กœ์ ํŠธ ํšŒ๊ณ 
728x90

1. ๋ฏธ๋‹ˆ ํ”„๋กœ์ ํŠธ๋ฅผ ๋งˆ์น˜๋ฉฐ

์›”์š”์ผ๋ถ€ํ„ฐ ์‹œ์ž‘๋œ ๋ฏธ๋‹ˆ ํ”„๋กœ์ ํŠธ๊ฐ€ ๋๋‚ฌ๋‹ค!..

์›”์š”์ผ ์˜คํ›„๋ถ€ํ„ฐ ์˜ค๋Š˜ ์˜ค์ „๊นŒ์ง€ 4์ผ์ด๋ผ๋Š” ์งง์€ ์‹œ๊ฐ„ ์•ˆ์—์„œ ๊ฒฐ๊ณผ๋ฌผ์„ ๋งŒ๋“ค์–ด๋ƒˆ๋‹ค๋Š” ๊ฒƒ์ด

๋‹ค ๋๋‚˜๊ณ  ๋ณด๋‹ˆ ๋Œ€๋‹จํ•˜๋‹ค๋Š” ์ƒ๊ฐ ๐Ÿ‘๐Ÿ‘

ํŠนํžˆ ์šฐ๋ฆฌ ํŒ€์€ ๋‚˜๋ฅผ ์ œ์™ธํ•˜๊ณ  ์ด๋Ÿฐ ๊ฐœ๋ฐœ ํ”„๋กœ์ ํŠธ๊ฐ€ ์ฒ˜์Œ์ธ ๋ถ„๋“ค์ด ๋Œ€๋ถ€๋ถ„์ด์—ˆ๋Š”๋ฐ,

๋๊นŒ์ง€ ํฌ๊ธฐํ•˜์ง€ ์•Š๊ณ  ๊นƒํ—ˆ๋ธŒ๋กœ ํ˜‘์—…๋„ ์ฐฉ์ฐฉ ํ•ด๋‚ธ ๊ฒƒ์ด ๋ฟŒ๋“ฏํ•˜๋‹ค ๐Ÿ˜Š

๋ฐœํ‘œ ํ›„ ํŠœํ„ฐ๋‹˜๋“ค์˜ ํ”ผ๋“œ๋ฐฑ์„ ๋ฐ”ํƒ•์œผ๋กœ ๊ฒฐ๊ณผ๋ฌผ์—์„œ ์ข‹์•˜๋˜ ๋ถ€๋ถ„๊ณผ ์•„์‰ฌ์› ๋˜ ๋ถ€๋ถ„, ๊ฐœ์„ ๋˜์—ˆ์Œ ํ•˜๋Š” ๋ถ€๋ถ„์„ ๋”ฐ๋กœ ์ •๋ฆฌํ•ด๋ณด๋ ค ํ•œ๋‹ค!

 

 

2. ์•„์‰ฌ์› ๋˜ ๋ถ€๋ถ„

2.1. ๋‹คํฌ ๋ชจ๋“œ ์ ์šฉ ๋””ํ…Œ์ผ

๋‹ด๋‹น ํŒŒํŠธ๋Š” ์•„๋‹ˆ์—ˆ์ง€๋งŒ, ๊ฐœ์ธ ํŽ˜์ด์ง€์—์„œ ๋‹คํฌ ๋ชจ๋“œ ์ ์šฉ ์‹œ์— ์ž…๋ ฅ์ฐฝ๊ณผ ๋ฐฉ๋ช…๋ก ๋ถ€๋ถ„๋„ ๋ณ€ํ™”๊ฐ€ ์žˆ์—ˆ์–ด์•ผ ํ–ˆ๋Š”๋ฐ

์ฑ™๊ธฐ์ง€ ๋ชปํ•ด ์‚ฌ์šฉ์„ฑ ๋ถ€๋ถ„์—์„œ ์•„์‰ฝ๋‹ค!

 

 

์›จ์ผ ๋ธŒ๋ผ์šฐ์ €์˜ ๊ฒฝ์šฐ, ๋‹คํฌ๋ชจ๋“œ์—์„œ ์•„๋ž˜์™€ ๊ฐ™์ด ์ž…๋ ฅ์ฐฝ์„ ํฌํ•จํ•œ ๋ชจ๋“  ๋ถ€๋ถ„์— ๋Œ€ํ•ด์„œ ๋‹คํฌ ๋ชจ๋“œ๊ฐ€ ์ ์šฉ๋˜์–ด ์žˆ์—ˆ๋‹ค.

๋‹ค๋ฅธ ์ผ€์ด์Šค๋ฅผ ๋จผ์ € ์•Œ์•„๋ณด์ง€ ๋ชปํ•œ ๊ฒƒ์ด ์•„์‰ฌ์›€ ๐Ÿฅบ..

์›จ์ผ ๋ธŒ๋ผ์šฐ์ € ๋‹คํฌ๋ชจ๋“œ

 

2.2. ์—๋Ÿฌ ์ฒ˜๋ฆฌ, ์œ ํšจ์„ฑ ๊ฒ€์‚ฌ

๊ฐœ์ธ ํ”„๋กœ์ ํŠธ์—์„œ ์œ ํšจ์„ฑ ๊ฒ€์‚ฌ๋ฅผ ๊ทธ๋ ‡๊ฒŒ ์ฒ˜๋ฆฌํ–ˆ์Œ์—๋„ ๋ถˆ๊ตฌํ•˜๊ณ ....

์ •์ž‘ ํŒ€ ํ”„๋กœ์ ํŠธ์—์„œ ๊นŒ๋จน๋‹ค๋‹ˆ ๐Ÿ˜‚ !....

๋‹ค์Œ ํ”„๋กœ์ ํŠธ๋ถ€ํ„ฐ๋Š” ์ ˆ๋Œ€ ์žŠ์ง€ ์•Š๊ณ  ์ฑ™๊ฒจ์•ผ์ง€

 

 

2.3. ๋‹คํฌ ๋ชจ๋“œ ์œ ์ง€

ํŽ˜์ด์ง€ ์ด๋™์‹œ ๋‹คํฌ ๋ชจ๋“œ๊ฐ€ ์œ ์ง€๋˜์ง€ ์•Š๋Š” ์ !..

์ด ๋ถ€๋ถ„์— ๋Œ€ํ•ด์„œ๋Š” ์‚ฌ์‹ค ๊ณ ๋ฏผํ–ˆ์—ˆ๋Š”๋ฐ ๊ณ ๋ฏผ๋งŒ ํ•˜๊ณ  ์‹œ๋„๋ฅผ ๋ชปํ•ด๋ด์„œ ๋งค์šฐ ์•„์‰ฝ๋‹ค.

 

ํŠœํ„ฐ๋‹˜์ด ํ˜„์—…์—์„œ๋Š” ๋ณดํ†ต ๋กœ์ปฌ์ด๋‚˜ ์„ธ์…˜ ์Šคํ† ๋ฆฌ์ง€์— ๋ณ€์ˆ˜๋ฅผ ์ ์šฉํ•ด์„œ ๋‹คํฌ ๋ชจ๋“œ๋ฅผ ์œ ์ง€ํ•œ๋‹ค๊ณ  ๋ง์”€ํ•ด์ฃผ์…จ๊ณ ,

์ถ”๊ฐ€์ ์œผ๋กœ OS๋ณ„, ์‚ฌ์šฉ์ž๋ณ„๋กœ ๊ธฐ๋ณธ์ ์œผ๋กœ ์ ์šฉ๋˜์–ด์žˆ๋Š” ๋ชจ๋“œ(๋‹คํฌ๋‚˜ ๋ผ์ดํŠธ)์— ๋”ฐ๋ผ

๋ฐ”๋กœ ํ•ด๋‹น ๋ชจ๋“œ๋กœ ๋ณด์—ฌ์ฃผ๋Š” ๊ฒƒ๋„ ์ข‹๋‹ค๋Š” ํ”ผ๋“œ๋ฐฑ์„ ์ฃผ์…จ๋‹ค.

 

๋‹คํฌ๋ชจ๋“œ ๋ฒ„ํŠผ์„ ํด๋ฆญํ–ˆ์„ ๋•Œ ๋กœ์ปฌ ์Šคํ† ๋ฆฌ์ง€์— ์ €์žฅํ•ด์„œ,

ํŽ˜์ด์ง€ ์ด๋™์‹œ์— ๋กœ์ปฌ ์Šคํ† ๋ฆฌ์ง€์— ์ €์žฅ๋œ ๋ถ€๋ถ„์„ ๊ฐ€์ ธ์™€์„œ ์ผ์น˜ํ•˜๋ฉด ๋‹คํฌ ๋ชจ๋“œ๋กœ ์œ ์ง€ํ•ด์ฃผ๋Š” ์‹์˜ ๋กœ์ง์„ ์“ฐ๋ฉด ๋  ๊ฒƒ ๊ฐ™๋‹ค๋Š” ์ƒ๊ฐ.

 

 

2.4. ์›น ํ‘œ์ค€ ๋ชป ์ฑ™๊น€...๐Ÿ˜‚

์ด๊ฑด ๊ฐœ์ธ์ ์œผ๋กœ ์ •๋ง ์ •๋ง ์•„์‰ฌ์šด ๋ถ€๋ถ„์ธ๋ฐ,

๊ฐœ์ธ ํŽ˜์ด์ง€ ๊ตฌ์กฐ ์งœ๋Š” ๊ฑธ ๋‚˜๋ˆ„์–ด์„œ ์ง„ํ–‰ํ–ˆ๊ณ  ํ•œ ๋ฒˆ์ฏค์€ ๋งˆ์ง€๋ง‰์— ๊ฐˆ๋ฌด๋ฆฌํ•˜๊ณ  ์‹ถ์—ˆ์ง€๋งŒ.. ๐Ÿฅน

๋˜ ์—ฌ๊ฑด์ด ๋˜์ง€ ์•Š์•„ ๊ตฌ์กฐ์ ์ธ ๋ถ€๋ถ„์—์„œ ์›น ํ‘œ์ค€์„ ์ฑ™๊ธฐ์ง€ ๋ชปํ–ˆ๋‹ค..!

์ด ๋ถ€๋ถ„์€ ํŒ€์›๋“ค์—๊ฒŒ๋„ ๋”ฐ๋กœ ์ „๋‹ฌํ•  ๊ณ„ํš์ด๋‹ค. ๐Ÿ™‚ ๊ฐ™์ด ์•Œ๋ฉด ์ข‹์œผ๋‹ˆ๊นŒ,,

 

 

3. ์ข‹์•˜๋˜ ๋ถ€๋ถ„

3.1. Restful ํ•˜๊ฒŒ ์ž‘์„ฑํ•œ API ๋„ค์ด๋ฐ

API ๋ผ์šฐํŠธ ์—ฐ๊ฒฐํ•˜๊ณ  ์ž‘๋ช…ํ•˜๋Š” ๊ฒƒ ๋˜ํ•œ ์˜๋„์น˜ ์•Š๊ฒŒ ๋‚ด๊ฐ€ ์ฑ™๊ธฐ๊ณ  ๋ง์•˜๋Š”๋ฐ.. (๋ผ์šฐํŒ…์— ์„ฑ๊ณตํ•œ ์‚ฌ๋žŒ์ด์—ˆ๊ธฐ ๋•Œ๋ฌธ)

API ๋„ค์ด๋ฐ์€ ๊ผญ Restful ํ•จ์„ ์ฑ™๊ธฐ๊ณ  ์‹ถ์—ˆ๋‹ค.

 

๋ฐฉ๋ช…๋ก์€ ์„œ๋ฒ„๊ฐ€ ๊ด€๋ฆฌํ•˜๋Š” ์ปฌ๋ ‰์…˜์ด์—ˆ๊ธฐ ๋•Œ๋ฌธ์— members์™€ board๋ผ๋Š” ๋ช…์‚ฌ๋“ค์„ ์‚ฌ์šฉํ•ด์„œ

๋ฉค๋ฒ„๋ณ„๋กœ ์ˆซ์ž๋ฅผ ์นด์šดํŒ… ํ•ด์„œ ๋งŒ๋“ค์—ˆ๋‹ค.

ํŠœํ„ฐ๋‹˜๋„ ์ด ๋ถ€๋ถ„์„ ์นญ์ฐฌํ•ด์ฃผ์…”์„œ ์ข‹์•˜๋‹ค. ๐Ÿ™Œ

 

REST API ๋„ค์ด๋ฐ ๊ฐ€์ด๋“œ

https://restfulapi.net/resource-naming/

 

REST Resource Naming Guide

In REST, having a strong and consistent REST resource naming strategy โ€“ will prove one of the best design decisions in the long term.

restfulapi.net

 

 

3.2. ๊นƒ ์ถฉ๋Œ์ด ๊ฑฐ์˜ ์—†์—ˆ๋‹ค

์–ด์ œ ํ•˜๋ฃจ ๋งŒ์— ๋ฐœ์ƒํ•œ PR๋งŒ ํ•ด๋„ ์—ฌ๋Ÿฌ ๊ฑด์ธ๋ฐ ์Šฌ๋ž™์—์„œ ์‹ค์‹œ๊ฐ„์œผ๋กœ ์„œ๋กœ PR ๋ณด๋ƒˆ๋‹ค, merge ๋๋‚ฌ๋‹ค, pull ํ•ด์ฃผ์„ธ์š” ๋“ฑ๋“ฑ

๋ฐ”๋กœ๋ฐ”๋กœ ์†Œํ†ต์„ ํ•ด๊ฐ€๋ฉฐ ์ง„ํ–‰ํ•ด์„œ์ธ์ง€ ์ถฉ๋Œ์ด๋ผ๋˜๊ฐ€ ๊ผฌ์ž„์ด ์ •๋ง ์—†์—ˆ๋‹ค!..

์šฐ๋ฆฌ ๋ชจ๋‘ PR์€ ์ฒ˜์Œ์ด์—ˆ๋Š”๋ฐ ์•„์ฃผ ๋†€๋ผ์šด ๋ถ€๋ถ„.. ๐Ÿ‘๐Ÿ‘

 

 

3.3. ํ˜‘์—…์ ์ธ ์ธก๋ฉด

์šฐ์„  ํ”ผ๊ทธ ์žผ์„ ์ฒ˜์Œ ์จ๋ดค๋Š”๋ฐ ์•„์ฃผ ์ข‹์€ ํ˜‘์—… ํˆด์ด์—ˆ๋‹ค.

ํŠนํžˆ ๋‹ค ๊ฐ™์ด ์•„์ด๋””์–ด ํšŒ์˜๋ฅผ ํ•˜๊ธฐ ์ ํ•ฉํ•œ ํˆด!.. (๊ทธ๋Ÿฌ๋Š” ์šฉ๋„์ง€๋งŒ)

 

๋‹ค์Œ ํ”„๋กœ์ ํŠธ ๋•Œ๋Š” ์•„์ด๋””์–ด ํšŒ์˜๋Š” ํ”ผ๊ทธ์žผ์—์„œ,

์ •๋ฆฌ์™€ ์ง„ํ–‰์‚ฌํ•ญ ๊ด€๋ฆฌ๋Š” ๋…ธ์…˜์—์„œ ํ•˜๋ฉด ๋” ์ข‹๊ฒ ๋‹ค๋Š” ์ƒ๊ฐ ๐Ÿ™‚ !.. (๋…ธ์…˜ ์ข‹์•„)

ํ”ผ๊ทธ์žผ ๋•๋ถ„์— ๊ฐ์ž ์ž‘์—…ํ•œ ๊ฐœ์ธ ํŽ˜์ด์ง€๋ฅผ ํ•ฉ์น˜๋Š” ๋ถ€๋ถ„๋„ ์„œ๋กœ ์ข‹์•˜๋˜ ๋ถ€๋ถ„์— ์Šคํ‹ฐ์ปค๋ฅผ ๋ถ™์ด๋ฉฐ ํ‰ํ™”๋กญ๊ฒŒ ์ง„ํ–‰ํ•  ์ˆ˜ ์žˆ์—ˆ๋‹ค.

์•„์‰ฌ์šด ๋ถ€๋ถ„์ด ์žˆ๋‹ค๋ฉด ์ฝ”๋”ฉ ์ปจ๋ฒค์…˜์ด๋‚˜ ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜์„ ์„ธ๋ถ€์ ์œผ๋กœ ์ •ํ•˜๊ณ  ํ–ˆ์Œ ๋” ์ข‹์•˜๊ฒ ๋‹ค ์‹ถ๋‹ค.

 

๋‹ค์Œ ํ”„๋กœ์ ํŠธ์—์„œ ์‹œ๋„ํ•ด๋ณผ ๋ถ€๋ถ„์ด ๋งŽ์€ ๋“ฏ.. ๐Ÿค”

 

 

4. ๐Ÿ‘€ KPT ํšŒ๊ณ  ๋ฐฉ๋ฒ•๋ก ์— ๋”ฐ๋ฅธ ์ด๋ฒˆ ํ”„๋กœ์ ํŠธ ๊ฐœ์ธ ํšŒ๊ณ 

4.1. Keep

  • ๊ธฐํš ๋‹จ๊ณ„์—์„œ ํ”ผ๊ทธ๋งˆ์˜ ํ”ผ๊ทธ์žผ์„ ์‚ฌ์šฉํ•ด์„œ ์ž์œ ๋กญ๊ฒŒ ์˜๊ฒฌ์„ ์ฃผ๊ณ  ๋ฐ›์€ ๊ฒƒ
  • ์–ด๋ ค์›Œํ–ˆ๋˜ ๋ถ€๋ถ„์— ๋Œ€ํ•ด์„œ ๋๊นŒ์ง€ ์‹œ๋„ํ•ด์„œ ํ•ด๊ฒฐํ•˜๊ณ  ์„ฑ๊ณตํ•œ ๊ฒƒ
  • ์ ๊ทน์ ์œผ๋กœ ์†Œํ†ตํ•˜๋ ค ํ–ˆ๋˜ ๊ฒƒ
  • ๊นƒํ—ˆ๋ธŒ๋ฅผ ์ด์šฉํ•˜๋ฉฐ ์‹ค์‹œ๊ฐ„ ์†Œํ†ตํ•˜๋ฉฐ ์ง„ํ–‰ํ•˜์—ฌ ์ถฉ๋Œ ์—†์ด ํ•ฉ์ณ๋‚˜๊ฐ„ ๊ฒƒ

 

4.2. Problem

๋ฌธ์ œ์ 

  • ๊ธฐํš ๋‹จ๊ณ„์—์„œ ์ข€ ๋” ์ƒ์„ธํ•œ ๊ธฐํš์ด ์ด๋ฃจ์–ด์ง€์ง€ ๋ชปํ•œ ๊ฒƒ (๊ธฐ๋Šฅ์ด๋‚˜ ํŽ˜์ด์ง€ ๊ตฌ์„ฑ, ํŒŒํŠธ ๋ถ„๋ฐฐ ๊ฐ™์€ ๋ถ€๋ถ„)
  • ๊ณ„ํš์„ ์กฐ๊ธˆ ๋Š์Šจํ•˜๊ฒŒ ์žก์•„์„œ ํ›„๋ฐ˜๋ถ€ ๋งˆ๋ฌด๋ฆฌ ์‹œ๊ฐ„์ด ์ด‰๋ฐ•ํ–ˆ๋˜ ์ 
  • ์ฝ”๋“œ ์ปจ๋ฒค์…˜์„ ์ƒ์„ธํžˆ ์ •ํ•˜์ง€ ์•Š์•„ ํ•ฉ์น˜๋Š” ๊ณผ์ •์—์„œ ์ถ”๊ฐ€์ ์ธ ์‹œ๊ฐ„์ด ์†Œ๋ชจ๋จ

์›์ธ

  • ํ˜‘์—… ํ”„๋กœ์ ํŠธ ๊ฒฝํ—˜ ๋ถ€์กฑ

ํ•ด๊ฒฐ๋ฐฉ์•ˆ

  • ํ”„๋กœ์ ํŠธ๋ฅผ ์‹œ์ž‘ํ•˜๋ฉฐ ๊ธฐํš ๋‹จ๊ณ„์—์„œ ์‹œ๊ฐ„์„ ๋„ˆ๋ฌด ์งง์ง€ ์•Š๊ฒŒ ์žก์œผ๋ฉฐ ๋„ฃ์„ ์ˆ˜ ์žˆ๋Š” ๊ธฐ๋Šฅ์— ๋Œ€ํ•ด ๋‹ค์–‘ํ•˜๊ฒŒ ์ƒ๊ฐํ•ด๋ณด๊ธฐ
  • ์ค‘๊ฐ„ ๋งˆ๊ฐ์„ ํฌํ•จํ•ด์„œ ์ •๊ธฐ์ ์œผ๋กœ ๊ฐœ์ธ ์ง„ํ–‰์‚ฌํ•ญ๊ณผ ํ”„๋กœ์ ํŠธ์˜ ํ˜„์žฌ ์ง„ํ–‰ ๋ฐฉํ–ฅ์— ๋Œ€ํ•œ ๋…ผ์˜ ์‹œ๊ฐ„์„ ๊ฐ€์ง€๊ธฐ
  • ๊ธฐํš ๋‹จ๊ณ„์—์„œ ์ฝ”๋“œ ์ปจ๋ฒค์…˜๊ณผ ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜์„ ์ •ํ•˜๊ธฐ

 

4.3. Try

  • ์ฝ”๋“œ ์ปจ๋ฒค์…˜๊ณผ ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜์— ๋Œ€ํ•ด ์•Œ์•„๋ณด๊ธฐ
  • ํ”„๋กœ์ ํŠธ ์‹œ์ž‘๊ณผ ์ง„ํ–‰์‚ฌํ•ญ์„ ๋…ธ์…˜์œผ๋กœ ์ •๋ฆฌํ•˜๊ณ  ๊ณต์œ ํ•˜๊ธฐ
  • ๊ธฐํš ๋‹จ๊ณ„์—์„œ ๊ฐœ์ธ ํŒŒํŠธ ๋ถ„๋ฐฐ๋ฅผ ๋ช…ํ™•ํ•˜๊ฒŒ ํ•˜๊ธฐ
  • ๊นƒํ—ˆ๋ธŒ์™€ ๋ธŒ๋žœ์น˜์— ๋Œ€ํ•ด ๋” ๊ณต๋ถ€ํ•˜๊ธฐ

 

 

 

์ผ์ฐจ์ ์œผ๋กœ ์ด๋ ‡๊ฒŒ ์ •๋ฆฌํ•ด๋ณธ๋‹ค.

์งง์€ ํ”„๋กœ์ ํŠธ์˜€์ง€๋งŒ ์ฒ˜์Œ ๋ณด๋Š” ์‚ฌ๋žŒ๋“ค๋ผ๋ฆฌ ์ด๋Ÿฐ ๊ฒฐ๊ณผ๋ฅผ ๋งŒ๋“ค์–ด๋ƒˆ๋‹ค๋Š” ๋ถ€๋ถ„์—์„œ ๋†€๋ž๊ณ !..

์งง๊ณ  ๊ตต๊ฒŒ ์„ฑ์žฅํ•œ ๋Š๋‚Œ์ด๋‹ค! ๐Ÿ™‚

728x90