Skip to content

API Reference

์˜ค์ง€ํ™˜ edited this page Sep 22, 2021 · 18 revisions

User


User > ์‚ฌ์šฉ์ž ๊ฒ€์ƒ‰

1. API ๊ธฐ๋ณธ ์ •๋ณด

๋ฉ”์„œ๋“œ ์š”์ฒญ URL ์„ค๋ช…
GET /user Handover ํšŒ์› ์กฐํšŒ

2. ์š”์ฒญ๋ณ€์ˆ˜

๋ณ€์ˆ˜๋ช… ํƒ€์ž… ํ•„์ˆ˜์—ฌ๋ถ€ ๊ธฐ๋ณธ ๊ฐ’
serviceNumber String N ์‚ฌ์šฉ์ž ๊ตฐ๋ฒˆ
name String N ์‚ฌ์šฉ์ž ์ด๋ฆ„
groupName String N ์‚ฌ์šฉ์ž๊ฐ€ ์†Œ์†๋œ ๊ทธ๋ฃน ์ด๋ฆ„

3. ์ถœ๋ ฅ๊ฒฐ๊ณผ

ํ•„๋“œ ํƒ€์ž… ์„ค๋ช…
name String ์‚ฌ์šฉ์ž ์ด๋ฆ„
rank String ์‚ฌ์šฉ์ž ๊ณ„๊ธ‰
title String ์‚ฌ์šฉ์ž ์ง์œ„
group String ์‚ฌ์šฉ์ž๊ฐ€ ์†ํ•œ ๋ถ€์„œ
email String ์‚ฌ์šฉ์ž ์ด๋ฉ”์ผ
tel String ์‚ฌ์šฉ์ž ์ „ํ™”๋ฒˆํ˜ธ

4. ์—๋Ÿฌ์ฝ”๋“œ

HTTP ์ฝ”๋“œ ์—๋Ÿฌ ๋ฉ”์„ธ์ง€ ์กฐ์น˜๋ฐฉ์•ˆ
401 Authentication Failed: ์ธ์ฆ์— ์‹คํŒจํ–ˆ์Šต๋‹ˆ๋‹ค. ๋กœ๊ทธ์ธ ์„ธ์…˜์„ ํ™•์ธํ•ด์ฃผ์„ธ์š”.
403 Forbidden: ๊ถŒํ•œ์ด ์—†์Šต๋‹ˆ๋‹ค.
404 Not Found: ๊ฒ€์ƒ‰ ๊ฒฐ๊ณผ๊ฐ€ ์—†์Šต๋‹ˆ๋‹ค.
500 Interner Server Error: ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์˜ค๋ฅ˜์ž…๋‹ˆ๋‹ค.

User > ์‚ฌ์šฉ์ž ์ƒ์„ฑ

1. API ๊ธฐ๋ณธ ์ •๋ณด

๋ฉ”์„œ๋“œ ์š”์ฒญ URL ์„ค๋ช…
POST /user Handover ์‚ฌ์šฉ์ž ์ƒ์„ฑ

2. ์š”์ฒญ๋ณ€์ˆ˜

๋ณ€์ˆ˜๋ช… ํƒ€์ž… ํ•„์ˆ˜์—ฌ๋ถ€ ๊ธฐ๋ณธ ๊ฐ’
serviceNumber String Y ์‚ฌ์šฉ์ž ๊ตฐ๋ฒˆ
password String Y ์‚ฌ์šฉ์ž ๋น„๋ฐ€๋ฒˆํ˜ธ
name String Y ์‚ฌ์šฉ์ž ์ด๋ฆ„
rank String Y ์‚ฌ์šฉ์ž ๊ณ„๊ธ‰
title String Y ์‚ฌ์šฉ์ž ์ง์œ„
groupId String Y ์‚ฌ์šฉ์ž ์†Œ์† ๋ถ€์„œ
email String Y ์‚ฌ์šฉ์ž ์ด๋ฉ”์ผ
tel String Y ์‚ฌ์šฉ์ž ์ „ํ™”๋ฒˆํ˜ธ

3. ์ถœ๋ ฅ๊ฒฐ๊ณผ

์ถœ๋ ฅ๊ฒฐ๊ณผ๋Š” ๋ณ„๋„๋กœ ์—†์œผ๋ฉฐ, ์ƒ์„ฑ์ด ์™„๋ฃŒ๋œ ๊ฒฝ์šฐ HTTP ์ฝ”๋“œ๊ฐ€ 201๋กœ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค.

4. ์—๋Ÿฌ์ฝ”๋“œ

HTTP ์ฝ”๋“œ ์—๋Ÿฌ ๋ฉ”์„ธ์ง€ ์กฐ์น˜๋ฐฉ์•ˆ
400 ์ž˜๋ชป๋œ ์š”์ฒญ ํ•„์ˆ˜ ์š”์ฒญ ๋ณ€์ˆ˜๋“ค์„ ๋ชจ๋‘ ์ž…๋ ฅํ–ˆ๋Š”์ง€ ํ™•์ธํ•ด์ฃผ์„ธ์š”.
400 Duplicated Key Error: serviceNumber is already exists.
500 Interner Server Error ์„œ๋ฒ„ ๋‚ด๋ถ€ ์˜ค๋ฅ˜์ž…๋‹ˆ๋‹ค. ๊ฐœ๋ฐœ์ž์—๊ฒŒ ๋ฌธ์˜ํ•ด์ฃผ์„ธ์š”.

User > ์‚ฌ์šฉ์ž ์ •๋ณด ๊ฐฑ์‹ 

1. API ๊ธฐ๋ณธ ์ •๋ณด

๋ฉ”์„œ๋“œ ์š”์ฒญ URL ์„ค๋ช…
UPDATE /user Handover ์‚ฌ์šฉ์ž ์ •๋ณด ๊ฐฑ์‹ 

2. ์š”์ฒญ๋ณ€์ˆ˜

๋ณ€์ˆ˜๋ช… ํƒ€์ž… ํ•„์ˆ˜์—ฌ๋ถ€ ๊ธฐ๋ณธ ๊ฐ’
serviceNumber String Y ์‚ฌ์šฉ์ž ๊ตฐ๋ฒˆ
password String N ์‚ฌ์šฉ์ž ๋น„๋ฐ€๋ฒˆํ˜ธ
name String N ์‚ฌ์šฉ์ž ์ด๋ฆ„
rank String N ์‚ฌ์šฉ์ž ๊ณ„๊ธ‰
title String N ์‚ฌ์šฉ์ž ์ง์œ„
groupId String N ์‚ฌ์šฉ์ž ์†Œ์† ๋ถ€์„œ
email String N ์‚ฌ์šฉ์ž ์ด๋ฉ”์ผ
tel String N ์‚ฌ์šฉ์ž ์ „ํ™”๋ฒˆํ˜ธ

3. ์ถœ๋ ฅ๊ฒฐ๊ณผ

์ถœ๋ ฅ๊ฒฐ๊ณผ๋Š” ๋ณ„๋„๋กœ ์—†์œผ๋ฉฐ, ๋ณ€๊ฒฝ์ด ์™„๋ฃŒ๋œ ๊ฒฝ์šฐ HTTP ์ฝ”๋“œ๊ฐ€ 204๋กœ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค.

4. ์—๋Ÿฌ์ฝ”๋“œ

HTTP ์ฝ”๋“œ ์—๋Ÿฌ ๋ฉ”์„ธ์ง€ ์กฐ์น˜๋ฐฉ์•ˆ
400 ์ž˜๋ชป๋œ ์š”์ฒญ ํ•„์ˆ˜ ์š”์ฒญ ๋ณ€์ˆ˜๋“ค์„ ๋ชจ๋‘ ์ž…๋ ฅํ–ˆ๋Š”์ง€ ํ™•์ธํ•ด์ฃผ์„ธ์š”.
401 Authentication Failed: ์ธ์ฆ์— ์‹คํŒจํ–ˆ์Šต๋‹ˆ๋‹ค. ๋กœ๊ทธ์ธ ์„ธ์…˜์„ ํ™•์ธํ•ด์ฃผ์„ธ์š”.
403 Forbidden: ๊ถŒํ•œ์ด ์—†์Šต๋‹ˆ๋‹ค.
404 Not Found: ์š”์ฒญํ•œ ๊ตฐ๋ฒˆ์„ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค.
500 Interner Server Error ์„œ๋ฒ„ ๋‚ด๋ถ€ ์˜ค๋ฅ˜์ž…๋‹ˆ๋‹ค. ๊ฐœ๋ฐœ์ž์—๊ฒŒ ๋ฌธ์˜ํ•ด์ฃผ์„ธ์š”.

User > ์‚ฌ์šฉ์ž ์‚ญ์ œ

1. API ๊ธฐ๋ณธ ์ •๋ณด

๋ฉ”์„œ๋“œ ์š”์ฒญ URL ์„ค๋ช…
DELETE /user Handover ์‚ฌ์šฉ์ž ์‚ญ์ œ

2. ์š”์ฒญ๋ณ€์ˆ˜

๋ณ€์ˆ˜๋ช… ํƒ€์ž… ํ•„์ˆ˜์—ฌ๋ถ€ ๊ธฐ๋ณธ ๊ฐ’
serviceNumber String Y ์‚ฌ์šฉ์ž ๊ตฐ๋ฒˆ

3. ์ถœ๋ ฅ๊ฒฐ๊ณผ

์ถœ๋ ฅ๊ฒฐ๊ณผ๋Š” ๋ณ„๋„๋กœ ์—†์œผ๋ฉฐ, ๋ณ€๊ฒฝ์ด ์™„๋ฃŒ๋œ ๊ฒฝ์šฐ HTTP ์ฝ”๋“œ๊ฐ€ 204๋กœ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค.

4. ์—๋Ÿฌ์ฝ”๋“œ

HTTP ์ฝ”๋“œ ์—๋Ÿฌ ๋ฉ”์„ธ์ง€ ์กฐ์น˜๋ฐฉ์•ˆ
400 ์ž˜๋ชป๋œ ์š”์ฒญ ํ•„์ˆ˜ ์š”์ฒญ ๋ณ€์ˆ˜๋“ค์„ ๋ชจ๋‘ ์ž…๋ ฅํ–ˆ๋Š”์ง€ ํ™•์ธํ•ด์ฃผ์„ธ์š”.
401 Authentication Failed: ์ธ์ฆ์— ์‹คํŒจํ–ˆ์Šต๋‹ˆ๋‹ค. ๋กœ๊ทธ์ธ ์„ธ์…˜์„ ํ™•์ธํ•ด์ฃผ์„ธ์š”.
403 Forbidden: ๊ถŒํ•œ์ด ์—†์Šต๋‹ˆ๋‹ค.
404 Not Found: ์š”์ฒญํ•œ ๊ตฐ๋ฒˆ์„ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค.
500 Interner Server Error ์„œ๋ฒ„ ๋‚ด๋ถ€ ์˜ค๋ฅ˜์ž…๋‹ˆ๋‹ค. ๊ฐœ๋ฐœ์ž์—๊ฒŒ ๋ฌธ์˜ํ•ด์ฃผ์„ธ์š”.
Clone this wiki locally