yeon's blog

[HTTP ์›น ๊ธฐ๋ณธ ์ง€์‹] HTTP ๋ฉ”์„œ๋“œ - HTTP API๋ฅผ ๋งŒ๋“ค์–ด๋ณด์ž ๋ณธ๋ฌธ

HTTP

[HTTP ์›น ๊ธฐ๋ณธ ์ง€์‹] HTTP ๋ฉ”์„œ๋“œ - HTTP API๋ฅผ ๋งŒ๋“ค์–ด๋ณด์ž

yeonii 2023. 12. 3. 14:25

๐ŸŒฑ HTTP API๋ฅผ ๋งŒ๋“ค์–ด๋ณด์ž

์š”๊ตฌ์‚ฌํ•ญ ๋ฐ API URI ์„ค๊ณ„

๐Ÿ‘‰ ํšŒ์› ์ •๋ณด ๊ด€๋ฆฌ API ์„ค๊ณ„
      1. ํšŒ์› ๋ชฉ๋ก ์กฐํšŒ :  /read-member-list
      2. ํšŒ์› ์กฐํšŒ :  /read-member-by-id
      3. ํšŒ์› ๋“ฑ๋ก : /create-member
      4. ํšŒ์› ์ˆ˜์ • : /update-member
      5. ํšŒ์› ์‚ญ์ œ : /delete-member

 

→ ์š”๊ตฌ์‚ฌํ•ญ ๊ธฐ๋ฐ˜์œผ๋กœ API๋ฅผ ๋งŒ๋“ค๊ฒŒ ๋˜๋ฉด ์œ„์™€ ๊ฐ™์ด ํ˜„์—…์—์„œ ์ž˜๋ชป๋œ API URI ์„ค๊ณ„๋ฅผ ํ•œ๋‹ค.

 

API URI ์„ค๊ณ„ ๋ถ„๋ฆฌ

๐Ÿ‘‰ ๋ฆฌ์†Œ์Šค: ํšŒ์›โœจโœจโœจ
    ํ–‰์œ„: ์กฐํšŒ, ๋“ฑ๋ก, ์ˆ˜์ •, ์‚ญ์ œ

 

→ ๋ฆฌ์†Œ์Šค ์‹๋ณ„ โ€ผ๏ธ

    API URI ์„ค๊ณ„๋ฅผ ํ•  ๋•Œ ๋ฆฌ์†Œ์Šค์™€ ํ•ด๋‹น ๋ฆฌ์†Œ์Šค๋ฅผ ๋Œ€์ƒ์œผ๋กœ ํ•˜๋Š” ํ–‰์œ„๋ฅผ ๋ถ„๋ฆฌํ•ด์•ผ ํ•œ๋‹ค.

    ํšŒ์›์ด๋ผ๋Š” ๋ฆฌ์†Œ์Šค๋งŒ ์‹๋ณ„ํ•˜๊ณ  ํšŒ์› ๋ฆฌ์†Œ์Šค๋ฅผ URI์— ๋งคํ•‘์„ ํ•˜๋ฉด ๋œ๋‹ค.

 

API URI ์žฌ์„ค๊ณ„

๐Ÿ‘‰ ํšŒ์› ์ •๋ณด ๊ด€๋ฆฌ API ์žฌ์„ค๊ณ„
      1. ํšŒ์› ๋ชฉ๋ก ์กฐํšŒ :  /members
      2. ํšŒ์› ์กฐํšŒ :  /members/{id}
      3. ํšŒ์› ๋“ฑ๋ก : /members/{id}
      4. ํšŒ์› ์ˆ˜์ • : /members/{id}
      5. ํšŒ์› ์‚ญ์ œ : /members/{id}

 

→ API URI ์žฌ์„ค๊ณ„๋ฅผ ํ–ˆ์ง€๋งŒ ํ–‰์œ„๋Š” ๊ตฌ๋ถ„์ด ๋˜์ง€ ์•Š๋Š”๋‹ค.

→ URI ๋ฆฌ์†Œ์Šค๋งŒ ์‹๋ณ„ํ•ด ๋†“์œผ๋ฉด HTTP ๋ฉ”์„œ๋“œ์ธ GET, POST, PUT, DELETE ์ด๋Ÿฐ ๊ฒƒ๋“ค์ด ์กฐํšŒ, ๋“ฑ๋ก, ์ˆ˜์ •, ์‚ญ์ œ ์—ญํ• ์„ ๋Œ€์‹ ํ•ด์ค€๋‹ค.

*๊ณ„์ธต ๊ตฌ์กฐ์ƒ ์ƒ์œ„๋ฅผ ์ปฌ๋ ‰์…˜์œผ๋กœ ๋ณด๊ณ  ๋ณต์ˆ˜ ๋‹จ์–ด ์‚ฌ์šฉ ๊ถŒ์žฅ(member โžก๏ธ members)