주소 설계 규칙(RESTful API)

SHIN's avatar
Aug 19, 2024
주소 설계 규칙(RESTful API)
 

pathvariable을 왜 쓰나?

💡
Get 요청 → DB select 요청
Controller에 적힌 주소를 적을 땐 Rest한 규칙이 있음
이 규칙이 바로 ‘주소 설계 규칙’
 
💡
  1. /board?title=제목 1 → primary가 아니면 querystring으로. → title이 유니크하지 않기에 특정 제목에 해당하는 모든 게시물 조회.
    1. SELECT * FROM board WHERE title = ‘제목’;
       
  1. /board?title=제목1&content=내용1 → title과 content를 함께 조회(게시물 필터링)
    1. SELECT * FROM board WHERE title = ‘제목1; AND content = ‘내용1’;
       
  1. /board/1 → id가 1인 특정 게시물 조회. (id = pk)
    1. SELECT * FROM board WHERE id = 1;
       
  1. /boards → 모든 게시물 조회
    1. SELECT * FROM board
       
  1. /users/1/boards → id가 1인 사용자가 작성한 전체 게시물 조회 (주소에서 쿼리가 보임) → 주소를 보고 크롤링(주소 분석 및 수집) 가능
    1. SELECT * FROM board_tb WHERE user_id = 1;
 
 
 
 

API 문서화

💡
클라이언트가 Rest Api 백엔드 어플리케이션에 요청 전송을 위해 알아야 하는 요청 정보 or URL/URI 등을 문서로 정리한 것
 
Share article

SHIN