๋ณธ๋ฌธ ๋ฐ”๋กœ๊ฐ€๊ธฐ

REST API Naming1

RESTful API ์„ค๊ณ„ ์›์น™ / ๋„ค์ด๋ฐ ๊ทœ์น™ RESTful API ํด๋ผ์ด์–ธํŠธ์™€ ์„œ๋ฒ„๊ฐ€ ๋ฐ์ดํ„ฐ๋ฅผ ์ฃผ๊ณ ๋ฐ›๋Š” ๋ฐฉ์‹์— ๋Œ€ํ•œ ์•„ํ‚คํ…์ฒ˜ ์Šคํƒ€์ผ RESTful API Naming ๋ฆฌ์†Œ์Šค ํ‘œํ˜„์— ๋ช…์‚ฌ๋ฅผ ์‚ฌ์šฉํ•˜๋ผ. ๊ณ„์ธต๊ด€๊ณ„๋ฅผ ๊ตฌ๋ถ„์ง“๊ธฐ ์œ„ํ•ด ์Šฌ๋ž˜์‹œ(/)๋ฅผ ์‚ฌ์šฉํ•˜๋ผ. URI ๋งˆ์ง€๋ง‰์— ์Šฌ๋ž˜์‹œ๋ฅผ ๋ถ™์ด์ง€ ๋งˆ๋ผ. ํ•˜์ดํ”ˆ(-) ๊ธฐํ˜ธ๋ฅผ ์‚ฌ์šฉํ•ด ๊ฐ€๋…์„ฑ์„ ๋†’์—ฌ๋ผ. ์–ธ๋”์Šค์ฝ”์–ด๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ๋งˆ๋ผ. ์†Œ๋ฌธ์ž๋งŒ์„ ์‚ฌ์šฉํ•˜๋ผ. ๋ฆฌ์†Œ์Šค ํ‘œํ˜„์— ๋ช…์‚ฌ๋ฅผ ์‚ฌ์šฉํ•˜๋ผ. RESTful URI ๊ฐ€ ๊ฐ€๋ฆฌํ‚ค๋Š” ๋ฆฌ์†Œ์Šค๋Š” ์ˆ˜ํ–‰๋˜๋Š” ํ–‰์œ„๊ฐ€ ์•„๋‹ˆ๋ผ ๊ฐ์ฒด์ด๋‹ค. ์ด ๋ฆฌ์†Œ์Šค๊ฐ€ ์–ด๋Š ๋ฒ”์ฃผ์— ํ•ด๋‹นํ•˜๋Š”์ง€ ํ™•์ธํ•˜๊ณ  ๊ทธ ๋ฒ”์ฃผ์— ๋งž๋Š” ๋„ค์ด๋ฐ ์ปจ๋ฒค์…˜์„ ์ผ๊ด€๋˜๊ฒŒ ์‚ฌ์šฉํ•ด์•ผ ํ•œ๋‹ค. โ˜‘๏ธ ๋ฌธ์„œ(Document) ๋‹จ์ผ ๊ฐœ๋…(ํŒŒ์ผ ํ•˜๋‚˜, ๊ฐ์ฒด ์ธ์Šคํ„ด์Šค, ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค row) ๋‹จ์ˆ˜ ์‚ฌ์šฉ(/device-management, /user-managemen.. 2023. 5. 8.

ํ‹ฐ์Šคํ† ๋ฆฌํˆด๋ฐ”