프로젝트/릴레이플로깅

[설계] API 명세

아모르AMORE 2024. 1. 19. 16:14

기본 URL http/test.com/api

API 설계

Rest 방식은 4가지 method를 사용해 crud 처리

  • Post - Create(쓰기)
  • Get - Read(읽기)
  • Put - Update(수정)
  • Delete - Delete(삭제)

http://192.168.0.1:3306/{영향을 끼칠 테이블이름}/{기능 이름}

기능 이름 예시) 회원가입, 로그인, 마이페이지 …

만약 영향을 끼칠 테이블이 여러개라면, 테이블 이름은 주 기능이 있는 테이블로 작성


마이페이지 프로필 변경 로직

  • mypage
  • PUT (update)
    • 닉네임, 휴대폰 - 무조건 update
    • url - 기존 이미지와 동일
    • 파일 - update 하기 (S3로 보내서 url 얻기)
    • multipart 로 안드로이드 -> 서버로 전송 -> 서버에서 S3 로 전송 -> S3 에서 url 얻어서 db 에 저장 -> 서버에서 안드로이드로 전송

마이페이지 GET 로딩

  • 처음 로그인할 때 한번에 내려주기로 함
  • POST /user/login/{token}

HTTP 통신 w/ Android

  • Retrofilt 클래스로 RestApi 인터페이스를 구현하여 서버와 통신
  • 모든 Http 요청에 헤더를 추가하기 위해서는 OkHttp interceptor 를 이용
  • 토큰 만료 시 갱신 API 인 api.refreshToken 메서드를 실행

'프로젝트 > 릴레이플로깅' 카테고리의 다른 글

[설계] JWT 원리  (0) 2024.01.19
[설계] DB  (0) 2024.01.19
[개요] 기획  (0) 2024.01.18