HomeAboutMeBlogGuest
© 2025 Sejin Cha. All rights reserved.
Built with Next.js, deployed on Vercel
🧚
[1기]최종 프로젝트 데브코스/
[팀3] 아이육
[팀3] 아이육/
🎁
API 설계
🎁

API 설계

최종 편집일
Apr 4, 2022 04:01 AM
날짜
Nov 23, 2021 06:22 PM
상태
설계
담당자
현호 유

API Docs

  • http://3.35.254.102:26134/docs/index.html
    • 가장 최신으로 유지될 api docs입니다.
    • 아직 작성중
  • develop server host
    • http://3.35.254.102:26134/
 
공통
  • 시도, 시군구 조회 API
  • 동물, 품종 조회 API
회원
  • 가입요청 API
  • 회원 조회 API
  • 로그인 API
    • 알림 목록
  • 로그아웃 API
  • 개인정보 수정 API
  • 비밀번호 수정 API
  • 본인의 작성 게시글 조회 API
  • 본인의 북마크 게시글 조회 API
    • 실종/보호
    • 보호소 동물
  • 회원 탈퇴 API
  • 관심 지역 설정 API
    • 지역 추가, 삭제, 알림 on/off
실종/보호 게시물
  • 게시글 등록 API
    • 해쉬태그
    • 이미지
  • 게시글 리스트 조회 API
    • 쿼리파람으로 조건 서치 가능(필터)
    • 해시태그
    • 썸네일
  • 게시글 단건 조회 API
    • + 댓글
  • 게시글 수정 API
  • 게시글 삭제 API
  • 북마크 등록/취소 API
보호소 동물
  • 게시글 리스트 조회 API
    • 필터링
 
  • 게시글 단건 조회 API
  • 북마크 등록/취소 API
댓글
  • 댓글 등록 API
  • 댓글 수정 API
  • 댓글 삭제 API
알림
  • 알림 삭제 API
  • 알림 조회 API
알림 키워드
  • 키워드 등록 API
  • 키워드 삭제 API
통계
  • 게시글 통계 조회 API
해시태그
  • 해시태그로 게시물 조회
  • 인기 해시태그 조회
 
r: 범키
g: 티거
b: 케빈
 
성공 응답이랑 → ApiResponse<>
에러 응답이랑 → ErrorResonse<>
 
Template
이름
uri
태그
상태
완료여부
안에 내용 복사해서 쓰면 간편간편~
/api/v1/cities
GET
200
완료여부
완료여부
회원 가입에 이메일인증을 할 것인지
다른 회원의 프로필을 볼 수 있는지
API 명세
이름
uri
태그
상태
담당자
완료여부
프론트 확인
비고
📝 공통
시도, 시군구 조회 API
/api/v1/cities
GET
200
티거
완료여부
동물, 품종 조회 API
/api/v1/animals
GET
200
케빈
완료여부
📝 회원
완료여부
이메일 전송 API
/api/v1/send-email
POST
204
티거
완료여부
이메일 인증 API
/api/v1/verify-email
POST
201
티거
완료여부
프론트 확인
회원 가입 API
/api/v1/sign-up
POST
201
티거
완료여부
로그인 API
/api/v1/login
POST
201
티거
완료여부
Oauth2 로그인
/oauth2/authorization/{소셜 이름}
GET
200
티거
완료여부
refresh token
/api/v1/refresh-token
POST
200
티거
완료여부
로그아웃 API
/api/v1/logout
POST
204
티거
완료여부
로그 찍기
개인정보 조회 API
/api/v1/me
GET
200
티거
완료여부
개인정보 수정 API
/api/v1/me
POST
204
티거
완료여부
회원 이미지 수정 (deprecated)
/api/v1/me/image
POST
204
티거
완료여부
회원 관심지역 조회 API
/api/v1/me/areas
GET
200
티거
완료여부
관심 지역 설정 API
/api/v1/me/areas
PUT
204
티거
완료여부
회원 관심지역 삭제 api
/api/v1/me/areas/{areaId}
DELETE
204
티거
완료여부
작성 게시글 조회 API
/api/v1/me/posts
GET
200
티거
완료여부
북마크 실종 게시물 조회
/api/v1/me/boomarks?status=missing
GET
200
티거
완료여부
타입?
북마크 보호소 게시물 조회
/api/v1/me/boomarks?status=shelter
GET
200
티거
완료여부
타입?
회원 탈퇴 API
/api/v1/me
DELETE
204
티거
완료여부
📝 실종/ 보호 게시물
완료여부
실종/보호 게시글 등록 API
/api/v1/missing-posts
POST
201
범키
완료여부
프론트 확인
enum 값들 토의
실종/보호 게시글 리스트 조회 API
/api/v1/missing-posts
GET
200
범키
완료여부
실종/보호 게시글 단건 조회 API
/api/v1/missing-posts/{postId}
GET
200
범키
완료여부
실종/보호 게시글 수정 API
/api/v1/missing-posts/{postId}
POST
200
범키
완료여부
실종/보호 게시글 삭제 API
/api/v1/missing-posts/{postId}
DELETE
204
범키
완료여부
댓글 삭제 신경쓰기
실종/보호 게시글 북마크 등록 API
/api/v1/missing-posts/{postId}/bookmark
POST
201
범키
완료여부
실종/보호 게시글 북마크 취소
/api/v1/missing-posts/{postId}/bookmark
DELETE
204
범키
완료여부
특정 게시글의 댓글 목록 API
/api/v1/missing-posts/{postId}/comments
GET
200
케빈
완료여부
📝 보호소 동물
게시글 리스트 조회 API
/api/v1/shelter-posts
GET
200
케빈
완료여부
게시글 단건 조회 API
/api/v1/shelter-posts/{postId}
GET
200
케빈
완료여부
북마크 등록 API
/api/v1/shelter-posts/{postId}/bookmark
POST
201
케빈
완료여부
북마크 취소 API
/api/v1/shelter-posts/{postId}/bookmark
DELETE
204
케빈
완료여부
📝 댓글
댓글 등록 API
/api/v1/comments
POST
201
케빈
완료여부
댓글 수정 API
/api/v1/comments/{commentId}
PATCH
200
케빈
완료여부
댓글 삭제 API
/api/v1/comments/{commentId}
DELETE
204
케빈
완료여부
📝 알림
알림 리스트 조회 API
/api/v1/notices
GET
200
티거
완료여부
알림 전체 삭제
/api/v1/notices
DELETE
204
티거
완료여부
알림 삭제 API
/api/v1/notices/{noticeId}
DELETE
204
티거
완료여부
알림 클릭 API(상태변경)
/api/v1/notices/{noticeId}
PATCH
204
티거
완료여부
📝 통계
게시글 통계 조회 API
/api/v1/statistics
GET
200
케빈
완료여부
📝 알림 키워드(pass)
키워드 등록 API
/api/v1/keywords
POST
201
완료여부
사용 X
키워드 삭제 API
/api/v1/keywords/{keywordId}
DELETE
204
완료여부
사용 X
📝 해시태그
완료여부
해시태그로 게시물 조회 API
/api/v1/post-tags/{postTagId}/posts
GET
200
케빈
완료여부
인기 해시태그 조회 API
/api/v1/post-tags/ranking
GET
200
케빈
완료여부
top x 정하기