Key Features

ํฌ์ŠคํŠธ๋งจ์œผ๋กœ API ํ˜ธ์ถœํ•˜๊ธฐ

ํฌ์ŠคํŠธ๋งจ์œผ๋กœ API ํ˜ธ์ถœํ•˜๊ธฐ

ํฌ์ŠคํŠธ๋งจ์œผ๋กœ API ํ˜ธ์ถœํ•˜๊ธฐ

API๋ฅผ ๋ฐฐํฌํ–ˆ๋‹ค๋ฉด ํด๋ผ์ด์–ธํŠธ ํˆด์„ ํ™œ์šฉํ•ด API๊ฐ€ ์ž˜ ๋™์ž‘ํ•˜๋Š”์ง€ ํ™•์ธํ•ด๋ณผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๋ณธ ๊ฐ€์ด๋“œ๋Š” ํฌ์ŠคํŠธ๋งจ(Postman)์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.


1๋‹จ๊ณ„: Postman ์„ค์น˜ ๋ฐ ์‹คํ–‰


Postman ํ™ˆํŽ˜์ด์ง€์—์„œ ํˆด์„ ๋‹ค์šด๋กœ๋“œํ•˜๊ณ  ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.

ํฌ์ŠคํŠธ๋งจ ํ™”๋ฉด ์ƒ๋‹จ์—์„œ + ๋ฒ„ํŠผ์„ ํ†ตํ•ด ์ƒˆ HTTP ์š”์ฒญ์„ ๋งŒ๋“ญ๋‹ˆ๋‹ค.


2๋‹จ๊ณ„: POST ๋ฉ”์„œ๋“œ ์„ค์ •


๋ฉ”์„œ๋“œ๋ฅผ POST๋กœ ์„ค์ •ํ•˜๊ณ  ์—”๋“œํฌ์ธํŠธ URL์„ ์ž…๋ ฅํ•ฉ๋‹ˆ๋‹ค.

์—”๋“œํฌ์ธํŠธ๋Š” API Usage ํŽ˜์ด์ง€์—์„œ ๊ฐ ํƒญ์„ ํด๋ฆญํ•˜๋ฉด ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.



3๋‹จ๊ณ„: POST - Headers ์„ค์ •


๋ฉ”๋‰ด์—์„œ Headers ํƒญ์„ ํด๋ฆญํ•˜๊ณ  Key๊ฐ’๊ณผ Value๊ฐ’์„ ์ž…๋ ฅํ•ฉ๋‹ˆ๋‹ค.

์ด๋•Œ Key๊ฐ’์— x-api-key๋ฅผ, Value๊ฐ’์— API Key๋ฅผ ์ž…๋ ฅํ•ฉ๋‹ˆ๋‹ค.

API Key ๋ฐœ๊ธ‰ ์‹œ ๋ฐ˜๋“œ์‹œ ์•ˆ์ „ํ•œ ๊ณณ์— ๋ณด๊ด€ํ•ด๋‘๊ณ  ๋ณต์‚ฌํ•˜์—ฌ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.



4๋‹จ๊ณ„: POST - Body ์„ค์ •


Body ํƒญ์— ์ง„์ž…ํ•˜์—ฌ Key๊ฐ’๊ณผ Value๊ฐ’์„ ์ž…๋ ฅํ•ฉ๋‹ˆ๋‹ค.

Key๊ฐ’์— params_json์„ ์ž…๋ ฅํ•˜๊ณ  Text๋กœ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.

Value๊ฐ’์—๋Š” ์‚ฌ์šฉํ•  ๋…ธ๋“œ์˜ Input ๋ฐ์ดํ„ฐ ์ •๋ณด๋ฅผ JSON ํ˜•ํƒœ๋กœ ์ž…๋ ฅํ•ฉ๋‹ˆ๋‹ค.

์˜ˆ์‹œ:


{

"Name": "Joy",

"BirthDay": "20010101"

}



๊ทธ ๋‹ค์Œ Send ๋ฒ„ํŠผ์„ ํด๋ฆญํ•˜๋ฉด ์š”์ฒญ ID(Request ID)๊ฐ€ ์ถœ๋ ฅ๋ฉ๋‹ˆ๋‹ค.


5๋‹จ๊ณ„: GET ๋ฉ”์„œ๋“œ ์„ค์ •


๋ฉ”์„œ๋“œ๋ฅผ GET์œผ๋กœ ์„ค์ •ํ•˜๊ณ  POST์™€ ๋˜‘๊ฐ™์ด ์—”๋“œํฌ์ธํŠธ URL์„ ์ž…๋ ฅํ•ฉ๋‹ˆ๋‹ค.

์ด๋•Œ, URL ๋’ค์— POST ์š”์ฒญ์œผ๋กœ ์–ป์€ ์š”์ฒญ ID(Request ID)๋ฅผ ๋‹ค์Œ๊ณผ ๊ฐ™์€ ํ˜•์‹์œผ๋กœ ๋ถ™์—ฌ๋„ฃ์Šต๋‹ˆ๋‹ค.

/{Request ID}/status



6๋‹จ๊ณ„: GET - Headers ์„ค์ •


๋ฉ”๋‰ด์—์„œ Headers ํƒญ์„ ํด๋ฆญํ•˜๊ณ  Key๊ฐ’๊ณผ Value๊ฐ’์„ ์ž…๋ ฅํ•ฉ๋‹ˆ๋‹ค.

์ž…๋ ฅ๊ฐ’๊ณผ ๋ฐฉ๋ฒ•์€ 3๋‹จ๊ณ„์™€ ๊ฐ™์Šต๋‹ˆ๋‹ค.



7๋‹จ๊ณ„: ๊ฒฐ๊ณผ ํ™•์ธ


GET ๋ฉ”์„œ๋“œ๋Š” Body๊ฐ’์„ ์„ค์ •ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

Send ๋ฒ„ํŠผ์„ ํด๋ฆญํ•˜๋ฉด API๋ฅผ ํ˜ธ์ถœํ•ด ๊ฒฐ๊ด๊ฐ’์„ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.



8๋‹จ๊ณ„: cURL ์‚ฌ์šฉ


์šฐ์ธก์—์„œ ๋ฒ„ํŠผ์„ ํด๋ฆญํ•˜๋ฉด cURL ์ฝ”๋“œ ์ƒ˜ํ”Œ์„ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.