API Document - codestates-seb/seb41_main_004 GitHub Wiki
νμ¬ μ΄ν리μΌμ΄μ μμ μ¬μ©ν μ μλ apiμ λλ€.
api μμΈμ 보 보λ¬κ°κΈ° click!
Spring REST Docs click!
api μμ²μ΄ μλ²μ μ κ°λμ§ νμΈνκΈ° μν ν μ€νΈ λλ©μΈμ λλ€.
| Method | μ΄λ¦ | μ€λͺ |
|---|---|---|
| GET | ν΅μ ν μ€νΈ | ν΅μ ν μ€νΈμ μ°μΌ apiμ λλ€. |
μ΄ν리μΌμ΄μ μΈμ¦μ κ΄ν λλ©μΈμ λλ€.
| Method | μ΄λ¦ | μ€λͺ |
|---|---|---|
| POST | λ‘κ·ΈμΈ | μ΄λ©μΌκ³Ό ν¨μ€μλλ₯Ό μ λ ₯λ°μ λ‘κ·ΈμΈν μ μμ΅λλ€. |
| POST | λΉλ°λ²νΈ μΈμ¦ | μ΄λ©μΌκ³Ό ν¨μ€μλλ₯Ό μ λ ₯λ°μ λ‘κ·ΈμΈν μ μμ΅λλ€. |
| PATCH | λΉλ°λ²νΈ λ³κ²½ | μ λΉλ°λ²νΈμ λΉλ°λ²νΈ νμΈμ μ λ ₯ν΄ λΉλ°λ²νΈλ₯Ό λ³κ²½ν μ μμ΅λλ€. |
| POST | λΉλ°λ²νΈ μ°ΎκΈ°(μ΄λ©μΌ μΈμ¦λ²νΈ λ°μ‘) | λλ€ λΉλ°λ²νΈλ₯Ό λ°μ‘νκΈ° μ μ΄λ©μΌ μΈμ¦μ μν μΈμ¦λ²νΈλ₯Ό λ°μ‘ν©λλ€. |
| POST | λΉλ°λ²νΈ μ°ΎκΈ°(λλ€ λΉλ°λ²νΈ λ°μ‘) | μ΄λ©μΌ μΈμ¦λ²νΈκ° μΌμΉνλ©΄ λλ€ μμ±ν λΉλ°λ²νΈλ₯Ό 보λ λλ€. |
| GET | ν ν° μ¬λ°κΈ | access tokenμ΄ λ§λ£λλ©΄ refresh tokenμ νμΈ ν μ¬λ°κΈ ν΄μ€λλ€. |
| POST | λ‘κ·Έμμ | λ‘κ·Έμμν νμμ refresh tokenμ μμ νκ³ , access tokenμ blacklistλ‘ μ μ₯ν©λλ€. |
νμ λλ©μΈμμ νμμ κ΄λ¦¬νλ apiμ λλ€.
| Method | μ΄λ¦ | μ€λͺ |
|---|---|---|
| POST | νμ μμ± | κ°μ νΌμ μ΄μ©νμ¬ νμ κ°μ ν μ μμ΅λλ€. |
| POST | λλ€μ μ€λ³΅ μ²΄ν¬ | νμκ°μ μ μ λ ₯ν λλ€μμ μ€λ³΅ μ¬λΆλ₯Ό νμΈν©λλ€. |
| POST | μ΄λ©μΌ μ€λ³΅ μ²΄ν¬ | νμ κ°μ μ μ λ ₯ν μ΄λ©μΌμ μ€λ³΅ μ¬λΆλ₯Ό νμΈν©λλ€. |
| PATCH | νμ μμ | νμ μ 보λ₯Ό μμ ν μ μμ΅λλ€. |
| POST | νμ νλ‘ν μ΄λ―Έμ§ μμ | νμ νλ‘ν μ΄λ―Έμ§λ₯Ό μμ ν μ μμ΅λλ€. |
| GET | νμ 1λͺ μ‘°ν | νΉμ νμμ λ§μ΄νμ΄μ§/μ μ νμ΄μ§λ₯Ό νμΈν μ μμ΅λλ€. |
| GET | νμ μ 체 μ‘°ν | μ 체 νμ λͺ©λ‘μ νμΈν μ μμ΅λλ€. |
| DELETE | νμ μμ (νν΄) | νμ μνλ₯Ό λΉνμ±νν©λλ€. |
| POST | νμ μ κ³ | νΉμ νμμ μ κ³ ν μ μμ΅λλ€. |
| GET | νλ λ΄μ μ 체 μ‘°ν | νΉμ νμμ νλ λ΄μμ μ‘°νν μ μμ΅λλ€. |
μ·¨λ―Έλ₯Ό κ°μ΄ λλ μμ§νΈ(λͺ¨μ)μ κ΄λ¦¬νλ api μ λλ€.
| Method | μ΄λ¦ | μ€λͺ |
|---|---|---|
| POST | μμ§νΈ μμ± | μμ§νΈλ₯Ό μμ±ν μ μμ΅λλ€. |
| GET | μ 체 μμ§νΈ μ‘°ν | μ 체 μμ§νΈλ₯Ό μ‘°νν μ μμ΅λλ€. |
| GET | κ°λ³ μμ§νΈ μ‘°ν | νΉμ μμ§νΈ 1κ°λ₯Ό μ‘°νν μ μμ΅λλ€. |
| GET | μΆμ² μμ§νΈ μ‘°ν | νμ μ 보μ μλ κ΄μ¬ μΉ΄ν κ³ λ¦¬λ₯Ό λ°νμΌλ‘ μΆμ² μμ§νΈλ₯Ό μ‘°νν μ μμ΅λλ€. λΉλ‘κ·ΈμΈ νμμ μ 체 μμ§νΈλ₯Ό μ‘°νν©λλ€. |
| GET | μΉ΄ν κ³ λ¦¬λ³ μμ§νΈ μ‘°ν | μΉ΄ν κ³ λ¦¬λ³λ‘ λͺ¨μμ μ‘°νν μ μμ΅λλ€. |
| GET | λ μ§λ³ μμ§νΈ μ‘°ν | λ μ§λ³λ‘ μμ§νΈλ₯Ό μ‘°νν μ μμ΅λλ€. |
| PATCH | μμ§νΈ μ 보 μμ | νΈμ€νΈκ° λ³ΈμΈμ΄ μμ±ν μμ§νΈμ μ 보λ₯Ό μμ ν μ μμ΅λλ€. |
| POST | μμ§νΈ λ°°λ μ΄λ―Έμ§ μμ | νΈμ€νΈκ° λ³ΈμΈμ΄ μμ±ν μμ§νΈμ λ°°λ μ΄λ―Έμ§λ₯Ό μμ ν μ μμ΅λλ€. |
| DELETE | μμ§νΈ μμ½ μ·¨μ | νΈμ€νΈκ° λ³ΈμΈμ΄ μμ±ν λͺ¨μμ μ·¨μν μ μμ΅λλ€. |
| GET | μμ§νΈ κ²μ | μ λͺ©κ³Ό λ΄μ©μ κ²μμ΄κ° ν¬ν¨λλ μμ§νΈλ₯Ό κ²μν μ μμ΅λλ€. |
| POST | μμ§νΈ μ κ³ | νΉμ μμ§νΈλ₯Ό μ κ³ ν μ μμ΅λλ€. |
| GET | μμ§νΈ μ°Έμ¬ μ§λ¬Έ μ‘°ν | μ°Έμ¬ μ μ² μ, νΈμ€νΈκ° μ€μ ν μ°Έμ¬ μ§λ¬Έμ μ‘°νν©λλ€. |
νΉμ μμ§νΈμ μ μ² μ¬νμ κ΄λ¦¬νλ api μ λλ€.
| Method | μ΄λ¦ | μ€λͺ |
|---|---|---|
| POST | μ°Έμ¬ μ μ² | μνλ λͺ¨μμ κ°μ μ μ²μ ν μ μμ΅λλ€. |
| GET | μ μ²μ/μ°Έμ¬μ μ 체 μ‘°ν | νΉμ λͺ¨μμ μ μ² λ° μ°Έμ¬ν νμμ μ‘°νν μ μμ΅λλ€. |
| PATCH | μ°Έμ¬ μΉμΈ/κ±°λΆ | νΈμ€νΈλ μ°Έμ¬ μ μ²ν νμμ μΉμΈ λλ κ±°μ ν μ μμ΅λλ€. κ±°μ λΉν νμμ λ€μ ν΄λΉ μμ§νΈμ μ°Έμ¬ μ μ²μ ν μ μμ΅λλ€. |
| PATCH | μ°Έμ¬ νμ κ°ν΄ | νΈμ€νΈλ νΉμ νμμ λͺ¨μμμ κ°ν΄ν μ μμ΅λλ€. κ°ν΄λΉν νμμ λ€μ ν΄λΉ μμ§νΈμ μ°Έμ¬ μ μ²μ ν μ μμ΅λλ€. |
| DELETE | μ°Έμ¬ μ μ² μ·¨μ λ° λκ°κΈ° | νΉμ νμμ λ§μ΄ννμμ λͺ¨μ μ°Έμ¬ μ μ²μ μ·¨μνκ±°λ, κ°μ λ λͺ¨μμμ λκ° μ μμ΅λλ€. μ μ²μ μ·¨μνκ±°λ, λκ° νμμ ν΄λΉ μμ§νΈμ μ¬μ μ²μ΄ κ°λ₯ν©λλ€.μ΄μ§/μ μ νμ΄μ§λ₯Ό νμΈν μ μμ΅λλ€. |
μμ§νΈ μ’ λ£μ μ°Έμ¬μλΌλ¦¬ μλ‘μ λν 리뷰λ₯Ό μμ±ν λ κ΄λ¦¬λλ apiμ λλ€.
| Method | μ΄λ¦ | μ€λͺ |
|---|---|---|
| POST | 리뷰 μμ± | λͺ¨μμ΄ μ’ λ£λλ©΄ μ°Έμ¬μλ μμ§νΈμ μ°Έμ¬ν νμμκ² λ¦¬λ·°λ₯Ό μμ±ν μ μμ΅λλ€. |
| PATCH | 리뷰 μ¨κΉ/μ¨κΉν΄μ | μ¬μ©μλ λ³ΈμΈμκ² μμ±λ 리뷰μ μ¨κΉ/κ³΅κ° μνλ₯Ό λ³κ²½ν©λλ€. |
| GET | νμ 리뷰 μ‘°ν | νΉμ νμμ λν 리뷰 μ 체λ₯Ό μ‘°νν μ μμ΅λλ€. |
μμ§νΈ κ΄λ ¨ μΉ΄ν κ³ λ¦¬λ₯Ό κ΄λ¦¬νλ apiμ λλ€.
| Method | μ΄λ¦ | μ€λͺ |
|---|---|---|
| GET | μ 체 μΉ΄ν κ³ λ¦¬ μ‘°ν | λλΆλ₯, μλΆλ₯λ₯Ό λͺ¨λ ν¬ν¨ν μΉ΄ν κ³ λ¦¬λ₯Ό μ‘°νν©λλ€. |
| GET | μ 체 λλΆλ₯ μΉ΄ν κ³ λ¦¬ μ‘°ν | λλΆλ₯ μΉ΄ν κ³ λ¦¬ μ 체 λͺ©λ‘μ μ‘°νν©λλ€. |
| GET | μ 체 μλΆλ₯ μΉ΄ν κ³ λ¦¬ μ‘°ν | μλΆλ₯ μΉ΄ν κ³ λ¦¬ μ 체 λͺ©λ‘μ μ‘°νν©λλ€. |
μμ§νΈ μ¬μ©μλΌλ¦¬ μλ‘λ₯Ό νλ‘μ°/νλ‘μν μ μμ΅λλ€.
| Method | μ΄λ¦ | μ€λͺ |
|---|---|---|
| POST | νλ‘μ° | νΉμ νμμ νλ‘μ°ν μ μμ΅λλ€. |
| POST | μΈνλ‘μ° | νΉμ νμμ μΈνλ‘μ°ν μ μμ΅λλ€. |
| GET | νλ‘μ 리μ€νΈ μ‘°ν | νΉμ νμμ νλ‘μ 리μ€νΈλ₯Ό μ‘°νν μ μμ΅λλ€. |
| GET | νλ‘μ 리μ€νΈ μ‘°ν | νΉμ νμμ νλ‘μ 리μ€νΈλ₯Ό μ‘°νν μ μμ΅λλ€. |
| GET | νλ‘μ° μ¬λΆ νμΈνκΈ° | νμ¬ λ‘κ·ΈμΈν μ μ μ νΉμ νμμ λν νλ‘μ° μ¬λΆλ₯Ό νμΈν μ μμ΅λλ€. |
| DELETE | νλ‘μ κ°μ ν΄μ | νμ λ³ΈμΈμ λλ₯Ό νλ‘μ°ν νλ‘μλ₯Ό κ°μ λ‘ νλ‘μ° ν΄μ ν μ μμ΅λλ€. |