๐Ÿ‘ฉ‍๐Ÿ’ปProgramming

[๋„คํŠธ์›Œํฌ] RESTful API

taesooya 2023. 7. 18.

RESTful API (Representational State Transfer API)

: ์›น ์„œ๋น„์Šค๋ฅผ ์œ„ํ•œ ์•„ํ‚คํ…์ฒ˜ ์Šคํƒ€์ผ. HTTP ์š”์ฒญ์„ ์‚ฌ์šฉํ•˜์—ฌ ๋ฆฌ์†Œ์Šค์— ์•ก์„ธ์Šคํ•˜๊ณ  ์กฐ์ž‘ํ•˜๋Š” ๋ฐฉ๋ฒ•์„ ์ •์˜ํ•จ

 

API (Application Programming Interface)

: ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜ ๊ฐ„์— ์ง€์ •๋œ ํ˜•์‹์œผ๋กœ ์š”์ฒญ๊ณผ ์‘๋‹ต์„ ํ•  ์ˆ˜ ์žˆ๋„๋ก ์—ฐ๊ฒฐํ•˜๋Š” ๊ฒƒ

  • Interface : ์‚ฌ๋žŒ๊ณผ ์‚ฌ๋žŒ, ์‚ฌ๋žŒ๊ณผ ์‚ฌ๋ฌผ ๋˜๋Š” ๊ธฐ๊ธฐ๋ฅผ ์—ฐ๊ฒฐํ•˜๋Š” ๊ฒƒ

  1. URI (Uniform Resource Identifier) - URI๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๋ฆฌ์†Œ์Šค๋ฅผ ์‹๋ณ„. HTTP๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•˜๋ฉฐ .Json์„ ์ฃผ๋กœ ์‚ฌ์šฉํ•จ. 
  2. HTTP ๋ฉ”์„œ๋“œ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ Create, Read, Update, Delete๋ฅผ ์ ์šฉ
    • GET ๋ฉ”์„œ๋“œ๋Š” ๋ฆฌ์†Œ์Šค๋ฅผ ์กฐํšŒ. POST ๋ฉ”์„œ๋“œ๋Š” ๋ฆฌ์†Œ์Šค๋ฅผ ์ƒ์„ฑ. PUT ๋ฉ”์„œ๋“œ๋Š” ๋ฆฌ์†Œ์Šค๋ฅผ ์—…๋ฐ์ดํŠธ.  DELETE ๋ฉ”์„œ๋“œ๋Š” ๋ฆฌ์†Œ์Šค๋ฅผ ์‚ญ์ œ
  3. HTTP ์š”์ฒญ ์‹œ ์–ด๋–ค URI์— ์–ด๋–ค ๋ฉ”์„œ๋“œ๋ฅผ ์‚ฌ์šฉํ• ์ง€์— ๋Œ€ํ•œ ์•ฝ์†
  4. Swagger UI๋Š” REST API๋ฅผ ๋ฌธ์„œํ™”ํ•˜๋Š” ํˆด

๋Œ“๊ธ€