REST๋ž€, REprensentational State Transfer์˜ ์•ฝ์ž์ด๋‹ค. ๋”ฐ๋ผ์„œ, RESTful API๋Š” REST์˜ ๊ธฐ๋ณธ ์›์น™์„ ์ž˜ ์ง€ํ‚จ API๋ฅผ ์˜๋ฏธํ•œ๋‹ค.

REST๋Š” ํ•˜๋‚˜์˜ ์•„ํ‚คํ…์ณ๋กœ, Resource Oriented Architecture์ด๋‹ค. API ์„ค๊ณ„์˜ ์ค‘์‹ฌ์— ์ž์›(resource)๊ฐ€ ์žˆ๊ณ , HTTP Method๋ฅผ ํ†ตํ•ด ์ž์›์„ ์ฒ˜๋ฆฌํ•˜๋„๋ก ์„ค๊ณ„ํ•˜๋Š” ๊ฒƒ์ด๋‹ค.

www์™€ ๊ฐ™์€ ๋ถ„์‚ฐ ํ•˜์ดํผ ๋ฏธ๋””์–ด ์‹œ์Šคํ…œ์„ ์œ„ํ•œ ์†Œํ”„ํŠธ์›จ์–ด ์•„ํ‚คํ…์ฒ˜์˜ ํ•œ ํ˜•์‹์œผ๋กœ, ์ž์›์„ ์ •์˜ํ•˜๊ณ  ์ž์›์— ๋Œ€ํ•œ ์ฃผ์†Œ๋ฅผ ์ง€์ •ํ•˜๋Š” ๋ฐฉ๋ฒ• ์ „๋ฐ˜์— ๋Œ€ํ•œ ํŒจํ„ด

REST ํŠน์ง•

  1. uniform interface
    • URI๋กœ ์ง€์ •ํ•œ ๋ฆฌ์†Œ์Šค์— ๋Œ€ํ•œ ์กฐ์ž‘์„ ํ†ต์ผ๋˜๊ณ  ํ•œ์ •์ ์ธ ์ธํ„ฐํŽ˜์ด์Šค๋กœ ์ˆ˜ํ–‰ํ•˜๋Š” ์•„ํ‚คํ…์ณ ์Šคํƒ€์ผ
  2. Stateless
    • API ์„œ๋ฒ„๋Š” ์ž‘์—…์„ ์œ„ํ•œ ์ƒํƒœ์ •๋ณด๋ฅผ ๋”ฐ๋กœ ์ €์žฅํ•˜์ง€ ์•Š๊ณ , ๋“ค์–ด์˜จ ์š”์ฒญ์„ ๋‹จ์ˆœํžˆ ์ฒ˜๋ฆฌํ•˜๋ฉด ๋œ๋‹ค.
    • ๋•Œ๋ฌธ์— ์„œ๋น„์Šค์˜ ์ž์œ ๋„๊ฐ€ ๋†’์•„์ง€๊ณ  ์„œ๋ฒ„์—์„œ ๋ถˆํ•„์š”ํ•œ ์ •๋ณด๋ฅผ ๊ด€๋ฆฌํ•˜์ง€ ์•Š์•„๋„ ๋œ๋‹ค.
  3. caching
    • HTTP๋ผ๋Š” ๊ธฐ์กด ์›นํ‘œ์ค€์„ ๊ทธ๋Œ€๋กœ ์‚ฌ์šฉํ•˜๊ธฐ์—, ์›น์—์„œ ์‚ฌ์šฉํ•˜๋Š” ๊ธฐ์กด ์ธํ”„๋ผ๋ฅผ ๊ทธ๋Œ€๋กœ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.
    • ๋”ฐ๋ผ์„œ HTTP๊ฐ€ ๊ฐ€์ง„ ์บ์‹ฑ ๊ธฐ๋Šฅ์„ ์ ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.
    • HTTP ํ”„๋กœํ† ์ฝœ ํ‘œ์ค€์—์„œ ์‚ฌ์šฉํ•˜๋Š” Last-Modified ํƒœ๊ทธ๋‚˜ E-Tag๋ฅผ ์ด์šฉํ•˜๋ฉด ์บ์‹ฑ ๊ตฌํ˜„์ด ๊ฐ€๋Šฅํ•˜๋‹ค/
  4. client-server
    • REST ์„œ๋ฒ„๋Š” API๋ฅผ ์ œ๊ณตํ•˜๊ณ , ํด๋ผ์ด์–ธํŠธ๋Š” ์‚ฌ์šฉ์ž ์ธ์ฆ์ด๋‚˜ ์ปจํ…์ŠคํŠธ(์„ธ์„ , ๋กœ๊ทธ์ธ์ •๋ณด) ๋“ฑ์„ ์ง์ ‘ ๊ด€๋ฆฌํ•˜๋Š” ๊ตฌ์กฐ๋กœ, ๊ฐ๊ฐ์˜ ์—ญํ• ์ด ํ™•์‹คํžˆ ๊ตฌ๋ถ„๋˜์–ด์žˆ๋‹ค.
    • ๋”ฐ๋ผ์„œ ํด๋ผ์ด์–ธํŠธ์™€ ์„œ๋ฒ„์—์„œ ๊ฐœ๋ฐœํ•ด์•ผํ•  ๋‚ด์šฉ์ด ๋ช…ํ™•ํ•ด์ง€๊ณ , ์„œ๋กœ๊ฐ„์˜ ์˜์กด์„ฑ์ด ์ค„์–ด๋“ ๋‹ค.
  5. hierarchical system
    • REST ์„œ๋ฒ„๋Š” ๋‹ค์ค‘ ๊ณ„์ธต์œผ๋กœ ๊ตฌ์„ฑ๋  ์ˆ˜ ์žˆ์œผ๋ฉฐ, ๋ณด์•ˆ/๋กœ๋“œ๋ฐธ๋Ÿฐ์‹ฑ/์•”ํ˜ธํ™” ๊ณ„์ธต์„ ์ถ”๊ฐ€ํ•ด ๊ตฌ์กฐ์ƒ์˜ ์œ ์—ฐ์„ฑ์„ ๋‘˜ ์ˆ˜ ์žˆ๊ณ , Proxy, ๊ฒŒ์ดํŠธ์›จ์ด ๊ฐ™์€ ๋„คํŠธ์›Œํฌ ๊ธฐ๋ฐ˜์˜ ์ค‘๊ฐ„ ๋งค์ฒด๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.
  6. Self-descriptiveness
    • REST API ๋ฉ”์‹œ์ง€๋งŒ ๋ณด๊ณ ๋„ ์ด๋ฅผ ์‰ฝ๊ฒŒ ์ดํ•ดํ•  ์ˆ˜ ์žˆ๋Š” ์ž์ฒด ํ‘œํ˜„๊ตฌ์กฐ๋กœ ๋˜์–ด์žˆ๋‹ค.

RESTfull ํ•˜๊ฒŒ API๋ฅผ ๋””์ž์ธ ํ•œ๋‹ค๋Š” ๊ฒƒ์˜ ์˜๋ฏธ

  1. ๋ฆฌ์†Œ์Šค์™€ ํ–‰์œ„๋ฅผ ๋ช…์‹œ์ ์ด๊ณ  ์ง๊ด€์ ์œผ๋กœ ๋ถ„๋ฆฌํ•œ๋‹ค.

    • ๋ฆฌ์†Œ์Šค๋Š” URI๋กœ ํ‘œํ˜„๋˜๋Š”๋ฐ, ๋ฆฌ์†Œ์Šค๊ฐ€ ๊ฐ€๋ฆฌํ‚ค๋Š” ๊ฒƒ์€ ๋ช…์‚ฌ๋กœ ํ‘œํ˜„๋˜์–ด์•ผํ•œ๋‹ค.
    • ํ–‰์œ„๋Š” HTTP Method๋กœ ํ‘œํ˜„ํ•˜๊ณ , GET, POST, PUT(์ „์ฒด ์ˆ˜์ •), PATCH(์ผ๋ถ€ ์ˆ˜์ •), DELETE ๊ฐ€ ์žˆ๋‹ค.
  2. Message๋Š” Header์™€ Body๋ฅผ ๋ช…ํ™•ํ•˜๊ฒŒ ๋ถ„๋ฆฌํ•ด์„œ ์‚ฌ์šฉํ•œ๋‹ค

    • entity์— ๋Œ€ํ•œ ๋‚ด์šฉ์€ body์— ๋‹ด๋Š”๋‹ค
    • ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ์„œ๋ฒ„๊ฐ€ ํ–‰๋™ํ•  ํŒ๋‹จ์˜ ๊ทผ๊ฑฐ๊ฐ€ ๋˜๋Š” ์ปจํŠธ๋กค ์ •๋ณด์ธ API ๋ฒ„์ „ ์ •๋ณด, ์‘๋‹ต๋ฐ›๊ณ ์ž ํ•˜๋Š” MIME ํƒ€์ž…๋“ฑ์€ header์— ๋‹ด๋Š”๋‹ค.
    • header์™€ body๋Š” http header์™€ http body๋กœ ๋‚˜๋ˆŒ ์ˆ˜ ์žˆ๊ณ , http body์— ๋“ค์–ด๊ฐ€๋Š” json ๊ตฌ์กฐ๋กœ ๋ถ„๋ฆฌํ•  ์ˆ˜ ์žˆ๋‹ค.
  3. API ๋ฒ„์ „์„ ๊ด€๋ฆฌํ•œ๋‹ค.

    • ํ™˜๊ฒฝ์€ ํ•ญ์ƒ ๋ณ€ํ•˜๊ธฐ๋•Œ๋ฌธ์— API์˜ signature๊ฐ€ ๋ณ€๊ฒฝ๋  ์ˆ˜๋„ ์žˆ์Œ์— ์œ ์˜ํ•˜์ž.
    • ํŠน์ • API๋ฅผ ๋ณ€๊ฒฝํ•  ๋•Œ๋Š” ๋ฐ˜๋“œ์‹œ ํ•˜์œ„ํ˜ธํ™˜์„ฑ์„ ๋ณด์žฅํ•ด์•ผํ•œ๋‹ค.
  4. ์„œ๋ฒ„์™€ ํด๋ผ์ด์–ธํŠธ๊ฐ€ ๊ฐ™์€ ๋ฐฉ์‹์„ ์‚ฌ์šฉํ•ด์„œ ์š”์ฒญํ•˜๋„๋ก ํ•œ๋‹ค.

    • ๋ธŒ๋ผ์šฐ์ €์™€ ์„œ๋ฒ„ ๋‘˜ ๋‹ค json์œผ๋กœ ๋ณด๋‚ด๋“ , form-data ํ˜•์‹์œผ๋กœ ๋ณด๋‚ด๋“  ํ•˜๋‚˜๋กœ ํ†ต์ผํ•œ๋‹ค.

    • ๋‹ค๋ฅธ ๋ง๋กœ ํ‘œํ˜„ํ•˜์ž๋ฉด, URI๊ฐ€ ํ”Œ๋žซํผ ์ค‘๋ฆฝ์ ์ด์–ด์•ผํ•œ๋‹ค๋Š” ๋ง์ด๋‹ค.

์žฅ๋‹จ์ 

์žฅ์ 

  • Open API๋ฅผ ์ œ๊ณตํ•˜๊ธฐ ์‰ฝ๋‹ค.
  • ๋ฉ€ํ‹ฐํ”Œ๋žซํผ ์ง€์› ๋ฐ ์—ฐ๋™์ด ์šฉ์ดํ•˜๋‹ค.
  • ์›ํ•˜๋Š” ํƒ€์ž…์œผ๋กœ ๋ฐ์ดํ„ฐ๋ฅผ ์ฃผ๊ณ  ๋ฐ›์„ ์ˆ˜ ์žˆ๋‹ค.
  • ๊ธฐ์กด ์›น ์ธํ”„๋ผ(HTTP)๋ฅผ ๊ทธ๋Œ€๋กœ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.

๋‹จ์ 

  • ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋Š” ๋ฉ”์„œ๋“œ๊ฐ€ ์ ๋‹ค.
  • ๋ถ„์‚ฐํ™˜๊ฒฝ์—๋Š” ๋ถ€์ ํ•ฉํ•˜๋‹ค.
  • HTTP ํ†ต์‹  ๋ชจ๋ธ์— ๋Œ€ํ•ด์„œ๋งŒ ์ง€์›ํ•œ๋‹ค.

์ถœ์ฒ˜

https://meetup.toast.com/posts/92