API Document - codestates-seb/seb41_main_004 GitHub Wiki

API Document

ν˜„μž¬ μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜μ—μ„œ μ‚¬μš©ν•  수 μžˆλŠ” apiμž…λ‹ˆλ‹€.

api 상세정보 λ³΄λŸ¬κ°€κΈ° click!
Spring REST Docs click!

1. Health Check

api μš”μ²­μ΄ μ„œλ²„μ— 잘 κ°€λŠ”μ§€ ν™•μΈν•˜κΈ° μœ„ν•œ ν…ŒμŠ€νŠΈ λ„λ©”μΈμž…λ‹ˆλ‹€.

Method 이름 μ„€λͺ…
GET 톡신 ν…ŒμŠ€νŠΈ ν†΅μ‹ ν…ŒμŠ€νŠΈμ— 쓰일 apiμž…λ‹ˆλ‹€.

2. Auth

μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜ 인증에 κ΄€ν•œ λ„λ©”μΈμž…λ‹ˆλ‹€.

Method 이름 μ„€λͺ…
POST 둜그인 이메일과 νŒ¨μŠ€μ›Œλ“œλ₯Ό μž…λ ₯λ°›μ•„ λ‘œκ·ΈμΈν•  수 μžˆμŠ΅λ‹ˆλ‹€.
POST λΉ„λ°€λ²ˆν˜Έ 인증 이메일과 νŒ¨μŠ€μ›Œλ“œλ₯Ό μž…λ ₯λ°›μ•„ λ‘œκ·ΈμΈν•  수 μžˆμŠ΅λ‹ˆλ‹€.
PATCH λΉ„λ°€λ²ˆν˜Έ λ³€κ²½ μƒˆ λΉ„λ°€λ²ˆν˜Έμ™€ λΉ„λ°€λ²ˆν˜Έ 확인을 μž…λ ₯ν•΄ λΉ„λ°€λ²ˆν˜Έλ₯Ό λ³€κ²½ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
POST λΉ„λ°€λ²ˆν˜Έ μ°ΎκΈ°(이메일 인증번호 λ°œμ†‘) 랜덀 λΉ„λ°€λ²ˆν˜Έλ₯Ό λ°œμ†‘ν•˜κΈ° μ „ 이메일 인증을 μœ„ν•œ 인증번호λ₯Ό λ°œμ†‘ν•©λ‹ˆλ‹€.
POST λΉ„λ°€λ²ˆν˜Έ μ°ΎκΈ°(랜덀 λΉ„λ°€λ²ˆν˜Έ λ°œμ†‘) 이메일 μΈμ¦λ²ˆν˜Έκ°€ μΌμΉ˜ν•˜λ©΄ 랜덀 μƒμ„±ν•œ λΉ„λ°€λ²ˆν˜Έλ₯Ό λ³΄λƒ…λ‹ˆλ‹€.
GET 토큰 μž¬λ°œκΈ‰ access token이 만료되면 refresh token을 확인 ν›„ μž¬λ°œκΈ‰ ν•΄μ€λ‹ˆλ‹€.
POST λ‘œκ·Έμ•„μ›ƒ λ‘œκ·Έμ•„μ›ƒν•œ νšŒμ›μ˜ refresh token을 μ‚­μ œν•˜κ³ , access token을 blacklist둜 μ €μž₯ν•©λ‹ˆλ‹€.

3. Member

νšŒμ› λ„λ©”μΈμ—μ„œ νšŒμ›μ„ κ΄€λ¦¬ν•˜λŠ” apiμž…λ‹ˆλ‹€.

Method 이름 μ„€λͺ…
POST νšŒμ› 생성 κ°€μž… 폼을 μ΄μš©ν•˜μ—¬ νšŒμ› κ°€μž…ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
POST λ‹‰λ„€μž„ 쀑볡 체크 νšŒμ›κ°€μž…μ‹œ μž…λ ₯ν•œ λ‹‰λ„€μž„μ˜ 쀑볡 μ—¬λΆ€λ₯Ό ν™•μΈν•©λ‹ˆλ‹€.
POST 이메일 쀑볡 체크 νšŒμ› κ°€μž…μ‹œ μž…λ ₯ν•œ μ΄λ©”μΌμ˜ 쀑볡 μ—¬λΆ€λ₯Ό ν™•μΈν•©λ‹ˆλ‹€.
PATCH νšŒμ› μˆ˜μ • νšŒμ› 정보λ₯Ό μˆ˜μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
POST νšŒμ› ν”„λ‘œν•„ 이미지 μˆ˜μ • νšŒμ› ν”„λ‘œν•„ 이미지λ₯Ό μˆ˜μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
GET νšŒμ› 1λͺ… 쑰회 νŠΉμ • νšŒμ›μ˜ λ§ˆμ΄νŽ˜μ΄μ§€/μœ μ €νŽ˜μ΄μ§€λ₯Ό 확인할 수 μžˆμŠ΅λ‹ˆλ‹€.
GET νšŒμ› 전체 쑰회 전체 νšŒμ› λͺ©λ‘μ„ 확인할 수 μžˆμŠ΅λ‹ˆλ‹€.
DELETE νšŒμ› μ‚­μ œ(νƒˆν‡΄) νšŒμ› μƒνƒœλ₯Ό λΉ„ν™œμ„±ν™”ν•©λ‹ˆλ‹€.
POST νšŒμ› μ‹ κ³  νŠΉμ • νšŒμ›μ„ μ‹ κ³ ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
GET ν™œλ™ λ‚΄μ—­ 전체 쑰회 νŠΉμ • νšŒμ›μ˜ ν™œλ™ 내역을 μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€.

4. Club

μ·¨λ―Έλ₯Ό 같이 λ‚˜λˆŒ μ•„μ§€νŠΈ(λͺ¨μž„)을 κ΄€λ¦¬ν•˜λŠ” api μž…λ‹ˆλ‹€.

Method 이름 μ„€λͺ…
POST μ•„μ§€νŠΈ 생성 μ•„μ§€νŠΈλ₯Ό 생성할 수 μžˆμŠ΅λ‹ˆλ‹€.
GET 전체 μ•„μ§€νŠΈ 쑰회 전체 μ•„μ§€νŠΈλ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€.
GET κ°œλ³„ μ•„μ§€νŠΈ 쑰회 νŠΉμ • μ•„μ§€νŠΈ 1개λ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€.
GET μΆ”μ²œ μ•„μ§€νŠΈ 쑰회 νšŒμ› 정보에 μžˆλŠ” 관심 μΉ΄ν…Œκ³ λ¦¬λ₯Ό λ°”νƒ•μœΌλ‘œ μΆ”μ²œ μ•„μ§€νŠΈλ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€. λΉ„λ‘œκ·ΈμΈ νšŒμ›μ€ 전체 μ•„μ§€νŠΈλ₯Ό μ‘°νšŒν•©λ‹ˆλ‹€.
GET μΉ΄ν…Œκ³ λ¦¬λ³„ μ•„μ§€νŠΈ 쑰회 μΉ΄ν…Œκ³ λ¦¬λ³„λ‘œ λͺ¨μž„을 μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€.
GET λ‚ μ§œλ³„ μ•„μ§€νŠΈ 쑰회 λ‚ μ§œλ³„λ‘œ μ•„μ§€νŠΈλ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€.
PATCH μ•„μ§€νŠΈ 정보 μˆ˜μ • ν˜ΈμŠ€νŠΈκ°€ 본인이 μƒμ„±ν•œ μ•„μ§€νŠΈμ˜ 정보λ₯Ό μˆ˜μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
POST μ•„μ§€νŠΈ λ°°λ„ˆ 이미지 μˆ˜μ • ν˜ΈμŠ€νŠΈκ°€ 본인이 μƒμ„±ν•œ μ•„μ§€νŠΈμ˜ λ°°λ„ˆ 이미지λ₯Ό μˆ˜μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
DELETE μ•„μ§€νŠΈ μ˜ˆμ•½ μ·¨μ†Œ ν˜ΈμŠ€νŠΈκ°€ 본인이 μƒμ„±ν•œ λͺ¨μž„을 μ·¨μ†Œν•  수 μžˆμŠ΅λ‹ˆλ‹€.
GET μ•„μ§€νŠΈ 검색 제λͺ©κ³Ό λ‚΄μš©μ— 검색어가 ν¬ν•¨λ˜λŠ” μ•„μ§€νŠΈλ₯Ό 검색할 수 μžˆμŠ΅λ‹ˆλ‹€.
POST μ•„μ§€νŠΈ μ‹ κ³  νŠΉμ • μ•„μ§€νŠΈλ₯Ό μ‹ κ³ ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
GET μ•„μ§€νŠΈ μ°Έμ—¬ 질문 쑰회 μ°Έμ—¬ μ‹ μ²­ μ‹œ, ν˜ΈμŠ€νŠΈκ°€ μ„€μ •ν•œ μ°Έμ—¬ μ§ˆλ¬Έμ„ μ‘°νšŒν•©λ‹ˆλ‹€.

5. Club Member

νŠΉμ • μ•„μ§€νŠΈμ— μ‹ μ²­ 사항을 κ΄€λ¦¬ν•˜λŠ” api μž…λ‹ˆλ‹€.

Method 이름 μ„€λͺ…
POST μ°Έμ—¬ μ‹ μ²­ μ›ν•˜λŠ” λͺ¨μž„에 κ°€μž… 신청을 ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
GET μ‹ μ²­μž/μ°Έμ—¬μž 전체 쑰회 νŠΉμ • λͺ¨μž„에 μ‹ μ²­ 및 μ°Έμ—¬ν•œ νšŒμ›μ„ μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€.
PATCH μ°Έμ—¬ 승인/κ±°λΆ€ ν˜ΈμŠ€νŠΈλŠ” μ°Έμ—¬ μ‹ μ²­ν•œ νšŒμ›μ„ 승인 λ˜λŠ” κ±°μ ˆν•  수 μžˆμŠ΅λ‹ˆλ‹€. κ±°μ ˆλ‹Ήν•œ νšŒμ›μ€ λ‹€μ‹œ ν•΄λ‹Ή μ•„μ§€νŠΈμ— μ°Έμ—¬ 신청을 ν•  수 μ—†μŠ΅λ‹ˆλ‹€.
PATCH μ°Έμ—¬ νšŒμ› 강퇴 ν˜ΈμŠ€νŠΈλŠ” νŠΉμ • νšŒμ›μ„ λͺ¨μž„μ—μ„œ 강퇴할 수 μžˆμŠ΅λ‹ˆλ‹€. κ°•ν‡΄λ‹Ήν•œ νšŒμ›μ€ λ‹€μ‹œ ν•΄λ‹Ή μ•„μ§€νŠΈμ— μ°Έμ—¬ 신청을 ν•  수 μ—†μŠ΅λ‹ˆλ‹€.
DELETE μ°Έμ—¬ μ‹ μ²­ μ·¨μ†Œ 및 λ‚˜κ°€κΈ° νŠΉμ • νšŒμ›μ˜ λ§ˆμ΄νŽ˜νšŒμ›μ€ λͺ¨μž„ μ°Έμ—¬ 신청을 μ·¨μ†Œν•˜κ±°λ‚˜, κ°€μž…λœ λͺ¨μž„μ—μ„œ λ‚˜κ°ˆ 수 μžˆμŠ΅λ‹ˆλ‹€. 신청을 μ·¨μ†Œν•˜κ±°λ‚˜, λ‚˜κ°„ νšŒμ›μ€ ν•΄λ‹Ή μ•„μ§€νŠΈμ— μž¬μ‹ μ²­μ΄ κ°€λŠ₯ν•©λ‹ˆλ‹€.이지/μœ μ €νŽ˜μ΄μ§€λ₯Ό 확인할 수 μžˆμŠ΅λ‹ˆλ‹€.

6. Review

μ•„μ§€νŠΈ μ’…λ£Œμ‹œ μ°Έμ—¬μžλΌλ¦¬ μ„œλ‘œμ— λŒ€ν•œ 리뷰λ₯Ό μž‘μ„±ν• λ•Œ κ΄€λ¦¬λ˜λŠ” apiμž…λ‹ˆλ‹€.

Method 이름 μ„€λͺ…
POST 리뷰 μž‘μ„± λͺ¨μž„이 μ’…λ£Œλ˜λ©΄ μ°Έμ—¬μžλŠ” μ•„μ§€νŠΈμ— μ°Έμ—¬ν•œ νšŒμ›μ—κ²Œ 리뷰λ₯Ό μž‘μ„±ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
PATCH 리뷰 μˆ¨κΉ€/μˆ¨κΉ€ν•΄μ œ μ‚¬μš©μžλŠ” λ³ΈμΈμ—κ²Œ μž‘μ„±λœ 리뷰의 μˆ¨κΉ€/곡개 μƒνƒœλ₯Ό λ³€κ²½ν•©λ‹ˆλ‹€.
GET νšŒμ› 리뷰 쑰회 νŠΉμ • νšŒμ›μ— λŒ€ν•œ 리뷰 전체λ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€.

7. Category

μ•„μ§€νŠΈ κ΄€λ ¨ μΉ΄ν…Œκ³ λ¦¬λ₯Ό κ΄€λ¦¬ν•˜λŠ” apiμž…λ‹ˆλ‹€.

Method 이름 μ„€λͺ…
GET 전체 μΉ΄ν…Œκ³ λ¦¬ 쑰회 λŒ€λΆ„λ₯˜, μ†ŒλΆ„λ₯˜λ₯Ό λͺ¨λ‘ ν¬ν•¨ν•œ μΉ΄ν…Œκ³ λ¦¬λ₯Ό μ‘°νšŒν•©λ‹ˆλ‹€.
GET 전체 λŒ€λΆ„λ₯˜ μΉ΄ν…Œκ³ λ¦¬ 쑰회 λŒ€λΆ„λ₯˜ μΉ΄ν…Œκ³ λ¦¬ 전체 λͺ©λ‘μ„ μ‘°νšŒν•©λ‹ˆλ‹€.
GET 전체 μ†ŒλΆ„λ₯˜ μΉ΄ν…Œκ³ λ¦¬ 쑰회 μ†ŒλΆ„λ₯˜ μΉ΄ν…Œκ³ λ¦¬ 전체 λͺ©λ‘μ„ μ‘°νšŒν•©λ‹ˆλ‹€.

8. Follow

μ•„μ§€νŠΈ μ‚¬μš©μžλΌλ¦¬ μ„œλ‘œλ₯Ό νŒ”λ‘œμš°/νŒ”λ‘œμž‰ν•  수 μžˆμŠ΅λ‹ˆλ‹€.

Method 이름 μ„€λͺ…
POST νŒ”λ‘œμš° νŠΉμ • νšŒμ›μ„ νŒ”λ‘œμš°ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
POST μ–ΈνŒ”λ‘œμš° νŠΉμ • νšŒμ›μ„ μ–ΈνŒ”λ‘œμš°ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
GET νŒ”λ‘œμ›Œ 리슀트 쑰회 νŠΉμ • νšŒμ›μ˜ νŒ”λ‘œμ›Œ 리슀트λ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€.
GET νŒ”λ‘œμž‰ 리슀트 쑰회 νŠΉμ • νšŒμ›μ˜ νŒ”λ‘œμž‰ 리슀트λ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€.
GET νŒ”λ‘œμš° μ—¬λΆ€ ν™•μΈν•˜κΈ° ν˜„μž¬ λ‘œκ·ΈμΈν•œ μœ μ €μ™€ νŠΉμ • νšŒμ›μ— λŒ€ν•œ νŒ”λ‘œμš° μ—¬λΆ€λ₯Ό 확인할 수 μžˆμŠ΅λ‹ˆλ‹€.
DELETE νŒ”λ‘œμ›Œ κ°•μ œ ν•΄μ œ νšŒμ› 본인은 λ‚˜λ₯Ό νŒ”λ‘œμš°ν•œ νŒ”λ‘œμ›Œλ₯Ό κ°•μ œλ‘œ νŒ”λ‘œμš° ν•΄μ œν•  수 μžˆμŠ΅λ‹ˆλ‹€.
⚠️ **GitHub.com Fallback** ⚠️