# 코드잇 실습용 서버 호스트 코드잇 실습용 서버 호스트입니다. ``` learn.codeit.kr ``` # 인증 (Authentication) 유저 인증과 관련된 API 엔드포인트입니다. ## 엔드포인트 ``` POST /v2/link-service/auth/login POST /v2/link-service/auth/token/refresh ``` # 로그인 유저 이메일과 비밀번호를 검증하여 인증합니다. ## 엔드포인트 ``` POST /v2/link-service/auth/login ``` 이메일과 비밀번호를 사용하여 유저를 인증합니다. ## 바디 파라미터 **email: string 필수** 유저의 이메일 주소입니다. **password: string 필수** 유저의 비밀번호입니다. ## 리턴 내용 인증에 성공하면 상태 코드 200과 함께 토큰이 리턴됩니다. 실패하면 상태 코드 401이 리턴됩니다. ## 리퀘스트 예시 ``` POST https://learn.codeit.kr/v2/link-service/auth/login Content-Type: application/json { "email": "holiday@afternoon.com", "password": "$3cr3t!" } ``` ## 리스폰스 예시 상태 코드: 200 ```jsx { "accessToken": "...", "refreshToken": "..." } ``` # 토큰 갱신 Refresh Token을 사용하여 새로운 인증 토큰을 발급받습니다. ## 엔드포인트 ``` POST /v2/link-service/auth/token/refresh ``` Refresh Token으로 새로운 인증 토큰을 발급받습니다. ## 리턴 내용 토큰 갱신에 성공하면 상태 코드 200과 함께 새로운 인증 토큰이 리턴됩니다. 인증 토큰 쿠키 없이 리퀘스트할 경우 상태 코드 401이 리턴됩니다. ## 리퀘스트 예시 ``` POST https://learn.codeit.kr/v2/link-service/auth/token/refresh Authorization: Bearer <리프레시 토큰> ``` ## 리스폰스 예시 상태 코드: 200 ```jsx { "accessToken": "...", "refreshToken": "..." } ``` # 유저 (Users) 유저 정보와 관련된 API 엔드포인트입니다. `/users/me` 아래의 엔드포인트에서는 `Authorization` 헤더로 인증 토큰을 보내야 합니다. ## 엔드포인트 ``` POST /v2/link-service/users GET /v2/link-service/users/me PATCH /v2/link-service/users/me GET /v2/link-service/users/me/links GET /v2/link-service/users/me/links/:id POST /v2/link-service/users/me/links PATCH /v2/link-service/users/me/links/:id DELETE /v2/link-service/users/me/links/:id GET /v2/link-service/users/:id GET /v2/link-service/users/:id/links ``` # 유저 생성 새로운 유저를 생성합니다. ## 엔드포인트 ``` POST /v2/link-service/users ``` 유저 정보를 사용하여 새로운 유저를 등록합니다. ## 바디 파라미터 **email: string 필수** 유저 이메일 주소입니다. **name: string 필수** 유저 이름입니다. **password: string 필수** 유저 비밀번호입니다. **bio: string** 유저의 소개말입니다. **avatar: file** 유저 아바타 이미지 파일입니다. (multipart/form-data) ## 리턴 내용 유저 생성에 성공하면 상태 코드 201과 함께 생성된 유저 객체가 리턴됩니다. 이미 해당 이메일로 가입한 유저가 존재하는 경우 상태 코드 409가 리턴됩니다. 그 외의 이유로 실패 시, 상태 코드 400이 리턴됩니다. ## 리퀘스트 예시 ``` POST https://learn.codeit.kr/v2/link-service/users Authorization: Bearer <액세스 토큰> Content-Type: multipart/form-data { "email": "holiday@afternoon.com", "name": "Sunny", "password": "$3cr3t", "avatar": (아바타 파일) } ``` ## 리스폰스 예시 상태 코드: 201 리스폰스로 `avatar`에 업로드된 이미지의 주소가 리턴됩니다. 만약 `avatar` 파일이 없는 경우 `null`이 리턴됩니다. ```json { "id": 42, "email": "holiday@afternoon.com", "name": "Sunny", "avatar": "https://learn.codeit.kr/.../avatar42.jpg", "bio": null, "createdAt": 1700138952, "updatedAt": 1700138952 } ``` # 현재 유저 정보 조회 인증된 현재 유저의 정보를 조회합니다. ## 엔드포인트 ``` GET /v2/link-service/users/me ``` 현재 인증된 유저의 정보를 리턴합니다. ## 리턴 내용 성공하면 상태 코드 200과 함께 현재 유저 객체가 리턴됩니다. 인증 토큰 없이 리퀘스트할 경우 상태 코드 401을 받습니다. ## 리퀘스트 예시 ``` GET https://learn.codeit.kr/v2/link-service/users/me Authorization: Bearer <액세스 토큰> ``` ## 리스폰스 예시 상태 코드: 200 ```json { "id": 42, "email": "holiday@afternoon.com", "name": "Sunny", "avatar": "https://learn.codeit.kr/.../avatar42.jpg", "bio": "햇살이 좋은 주말 오후", "createdAt": 1700138952, "updatedAt": 1700138952 } ``` # 현재 유저 정보 수정 인증된 현재 유저의 정보를 수정합니다. ## 엔드포인트 ``` PATCH /v2/link-service/users/me Authorization: Bearer <액세스 토큰> ``` 유저의 정보를 수정합니다. 아바타 이미지도 변경할 수 있습니다. ## 바디 파라미터 **email: string** 유저 이메일 주소입니다. **name: string** 유저 이름입니다. **bio: string** 유저의 간단한 소개입니다. **avatar: file** 유저 아바타 이미지 파일입니다. (multipart/form-data) ## 리턴 내용 성공하면 상태 코드 200과 함께 수정된 유저 객체가 리턴됩니다. 실패 시, 상태 코드 400과 함께 에러 메시지가 리턴됩니다. 인증 쿠키 없이 요청할 경우 상태 코드 401을 받습니다. ## 리퀘스트 예시 ``` PATCH https://learn.codeit.kr/v2/link-service/users/me Authorization: Bearer <액세스 토큰> Content-Type: multipart/form-data { "bio": "배움의 기쁨을 세상 모두에게", "avatar": (이미지 파일) } ``` ## 리스폰스 예시 상태 코드: 200 ```json { "id": 42, "email": "holiday@afternoon.com", "name": "Sunny", "avatar": "https://learn.codeit.kr/.../avatar42.jpg", "bio": "배움의 기쁨을 세상 모두에게", "createdAt": 1700138952, "updatedAt": 1700138952 } ``` # 현재 유저 삭제 인증된 현재 유저를 삭제합니다. ## 엔드포인트 ``` DELETE /v2/link-service/users/me ``` 현재 인증된 유저를 삭제합니다. ## 리턴 내용 성공하면 상태 코드 204와 함께 아무런 내용이 리턴되지 않습니다. 실패 시, 상태 코드 400과 함께 에러 메시지가 리턴됩니다. 인증 토큰 없이 요청할 경우 상태 코드 401을 받습니다. ## 리퀘스트 예시 ``` DELETE https://learn.codeit.kr/v2/link-service/users/me Authorization: Bearer <액세스 토큰> ``` ## 리스폰스 예시 상태 코드: 204 (리스폰스 바디 없음) # 현재 유저의 링크 목록 조회 인증된 현재 유저의 링크 목록을 조회합니다. ## 엔드포인트 ``` GET /v2/link-service/users/me/links ``` 현재 유저의 링크 목록을 리턴합니다. ## 리턴 내용 성공하면 상태 코드 200과 함께 유저의 링크 목록이 리턴됩니다. 인증 쿠키 없이 요청할 경우 상태 코드 401을 받습니다. ## 리퀘스트 예시 ``` GET https://learn.codeit.kr/v2/link-service/users/me/links Authorization: Bearer <액세스 토큰> ``` ## 리스폰스 예시 상태 코드: 200 ```json [ { "id": 1, "title": "포트폴리오 사이트", "url": "https://portfolio.sunnyafternoon.io", "thumbUrl": "https://portfolio.sunnyafternoon.io/.../thumb.jpg", "createdAt": 1700466131, "updatedAt": 1700466131 }, { "id": 2, "title": "인스타그램", "url": "https://instagram.com/holiday.with.codeit", "thumbUrl": "https://portfolio.sunnyafternoon.io/.../thumb.jpg", "createdAt": 1920469131, "updatedAt": 1920876203 }, // ... ] ``` # 특정 유저의 링크 상세 조회 인증된 현재 유저의 특정 링크를 조회합니다. ## 엔드포인트 ``` GET /v2/link-service/users/me/links/:id ``` 특정 링크 ID를 가진 유저의 링크 정보를 리턴합니다. ## 리턴 내용 성공하면 상태 코드 200과 함께 링크 객체가 리턴됩니다. 링크를 찾을 수 없는 경우 404 상태 코드가 리턴됩니다. 인증 토큰 없이 요청할 경우 상태 코드 401을 받습니다. ## 리퀘스트 예시 ``` GET https://learn.codeit.kr/v2/link-service/users/me/links/2 Authorization: Bearer <액세스 토큰> ``` ## 리스폰스 예시 상태 코드: 200 ```json { "id": 2, "title": "인스타그램", "url": "https://instagram.com/holiday.with.codeit", "thumbUrl": "https://portfolio.sunnyafternoon.io/.../thumb.jpg", "createdAt": 1920469131, "updatedAt": 1920876203 } ``` # 현재 유저의 링크 생성 인증된 현재 유저의 새로운 링크를 생성합니다. ## 엔드포인트 ``` POST /v2/link-service/users/me/links ``` 새로운 링크 정보를 사용하여 링크를 생성합니다. ## 바디 파라미터 **url: string 필수** 링크의 URL 주소입니다. **title: string 필수** 링크의 제목입니다. ## 리턴 내용 성공하면 상태 코드 200과 함께 생성된 링크 객체가 리턴됩니다. 실패 시, 상태 코드 400과 함께 에러 메시지가 리턴됩니다. 인증 쿠키 없이 요청할 경우 상태 코드 401을 받습니다. ## 리퀘스트 예시 ``` POST https://learn.codeit.kr/v2/link-service/users/me/links Authorization: Bearer <액세스 토큰> Content-Type: application/json { "title": "인스타그램", "url": "https://instagram.com/holiday.with.codeit", } ``` ## 리스폰스 예시 상태 코드: 200 ```json { "id": 2, "title": "인스타그램", "url": "https://instagram.com/holiday.with.codeit", "thumbUrl": "https://portfolio.sunnyafternoon.io/.../thumb.jpg", "createdAt": 1920469131, "updatedAt": 1920876203 }, ``` # 현재 유저의 링크 수정 인증된 현재 유저의 특정 링크 정보를 수정합니다. ## 엔드포인트 ``` PATCH /v2/link-service/users/me/links/:id ``` 링크 ID와 새로운 정보를 사용하여 링크를 수정합니다. ## 바디 파라미터 **title: string** 링크의 새로운 제목입니다. **url: string** 링크의 새로운 URL 주소입니다. ## 리턴 내용 성공하면 상태 코드 200과 함께 수정된 링크 객체가 리턴됩니다. 링크를 찾을 수 없는 경우 404 상태 코드가 리턴됩니다. 인증 토큰 없이 요청할 경우 상태 코드 401을 받습니다. ## 리퀘스트 예시 ``` PATCH https://learn.codeit.kr/v2/link-service/users/me/links/2 Authorization: Bearer <액세스 토큰> Content-Type: application/json { "title": "Instagram @holiday.with.codeit", } ``` ## 리스폰스 예시 상태 코드: 200 ```json { "id": 2, "title": "Instagram @holiday.with.codeit", "url": "https://instagram.com/holiday.with.codeit", "thumbUrl": "https://portfolio.sunnyafternoon.io/.../thumb.jpg", "createdAt": 1920469131, "updatedAt": 1920899203 } ``` # 현재 유저의 링크 삭제 인증된 현재 유저의 특정 링크를 삭제합니다. ## 엔드포인트 ``` DELETE /v2/link-service/users/me/links/:id ``` 링크 ID를 사용하여 링크를 삭제합니다. ## 리턴 내용 성공하면 상태 코드 204와 함께 아무런 내용이 리턴되지 않습니다. 링크를 찾을 수 없는 경우 404 상태 코드가 리턴됩니다. 인증 토큰 없이 요청할 경우 상태 코드 401을 받습니다. ## 리퀘스트 예시 ``` DELETE https://learn.codeit.kr/v2/link-service/users/me/links/1 Authorization: Bearer <액세스 토큰> ``` ## 리스폰스 예시 상태 코드: 204 (리스폰스 바디 없음) # 특정 유저 조회 특정 유저의 정보를 조회합니다. ## 엔드포인트 ``` GET /v2/link-service/users/:id ``` 유저 ID를 사용하여 유저 정보를 조회합니다. ## 리턴 내용 성공하면 상태 코드 200과 함께 유저 객체가 리턴됩니다. 유저를 찾을 수 없는 경우 404 상태 코드가 리턴됩니다. ## 리퀘스트 예시 ``` GET https://learn.codeit.kr/v2/link-service/users/1 ``` ## 리스폰스 예시 상태 코드: 200 ```json { "id": 1, "email": "holiday@afternoon.com", "name": "Sunny", "avatar": "https://learn.codeit.kr/.../avatar.jpg", "createdAt": 1700322109, "updatedAt": 1700466311 } ``` # 특정 유저의 링크 목록 조회 특정 유저의 링크 목록을 조회합니다. ## 엔드포인트 ``` GET /v2/link-service/users/:id/links ``` 유저 ID를 사용하여 해당 유저의 링크 목록을 조회합니다. ## 리턴 내용 성공하면 상태 코드 200과 함께 유저의 링크 목록이 리턴됩니다. ## 리퀘스트 예시 ``` GET https://learn.codeit.kr/v2/link-service/users/1/links ``` ## 리스폰스 예시 상태 코드: 200 ```json [ { "id": 1, "title": "포트폴리오 사이트", "url": "https://portfolio.sunnyafternoon.io", "thumbUrl": "https://portfolio.sunnyafternoon.io/.../thumb.jpg", "createdAt": 1700466131, "updatedAt": 1700466131 }, { "id": 2, "title": "Instagram @holiday.with.codeit", "url": "https://instagram.com/holiday.with.codeit", "thumbUrl": "https://portfolio.sunnyafternoon.io/.../thumb.jpg", "createdAt": 1920469131, "updatedAt": 1920876203 }, // ... ] ```