[Spring Blog]스프링 블로그 - API 설계

[Spring Blog]스프링 블로그 - 개념적설계 (tistory.com)

[Spring Blog]스프링 블로그 - 개념적설계

[Spring Blog]스프링 블로그 - 논리적 설계, 물리적 설계 (tistory.com)

[Spring Blog]스프링 블로그 - 논리적 설계, 물리적 설계

📝API URL 설계해보기

효과적인 API 설계는 팀원의 프로젝트 참여와 이해에 도움을 준다.

 

🚩 1. 개체 기준으로 베이스 잡기

No.	개체	릴레이션
1	회원	회원(회원아이디, 비밀번호, 전화번호)
2	게시글	게시글(게시글번호, 작성자, 제목, 내용, 작성날짜, 조회수, 추천수, 카테고리)
3	파일	파일(파일번호, 저장파일이름

 

No.	개체	URL
1	회원	/member
2	게시글	/board, /boards
3	파일	파일은 따로 보여주는 것이 없기에 제외

 

🚩2. 요구사항 기준으로 만들어보자

기본 기능

URL	Method	기능
/login	GET	로그인 페이지 이동
/login	POST	로그인 인증
/join	GET	회원가입 페이지 이동
/join	POST	회원가입

회원

회원은 기본적으로 시큐리티를 이용해 대상을 식별하므로, 경로에 정보가 없어도 된다.

URL	Method	기능
/member	GET	본인 정보 조회
/member/boards	GET	본인 작성 글 조회
/member/update	GET	본인 정보 수정 페이지 이동
/member/update	POST	본인 정보 수정 요청

 

게시글

URL	Method	기능
/board	GET	전체 게시글 조회
/boards/{board_id}	GET	특정 게시글 조회
/board/create	GET	게시글 작성 페이지
/board/create	POST	게시글 작성
/board/{board_id}/update	POST	게시글 수정
/board/{board_id}/delete	GET	게시글 삭제
/board/{board_id}/recommed	GET	게시글 추천
/board/{board_id}/comments	POST	게시글 댓글 작성
/board/{board_id}/comments/{comment_id}/update	POST	게시글 댓글 수정
/board/{board_id}/comments/{comment_id}/delete	GET	게시글 댓글 삭제

 

 

 

(1) 5분만에 제대로 설계하는 ⭐️ REST API - YouTube