본문 바로가기
BackEnd/Project

[Board] Ch01. API 설계

by 개발 Blog 2024. 8. 6.

공부 내용을 정리하고 앞으로의 학습에 이해를 돕기 위해 작성합니다.

 

API 설계

유즈케이스를 토대로 API와 뷰의 엔드포인트를 설정해 보고, 그다음에는 API들의 스펙을 정의하였다.

아래는 게시판 서비스 API 설계에 대한 내용이다.

 

게시판 서비스 API 설계

우선, 게시판 서비스의 API와 뷰 엔드포인트를 다음과 같이 정의하였다

다음으로, 각 API의 스펙을 정의하여 다음과 같은 표로 정리하였다

이 표를 통해 각 API 엔드포인트의 URI, HTTP 메서드, 그리고 입력 데이터 구성을 명확히 이해할 수 있다. 이러한 API 설계를 통해 게시판 서비스 시스템의 개발을 효율적으로 진행할 수 있다.

 

이번 작업을 통해 게시판 서비스의 API 구조를 명확히 하고, 이를 바탕으로 안정적인 기능 구현이 가능하게 되었다.

앞으로의 단계에서는 설계된 API를 기반으로 실제 개발을 진행하고, 각 기능의 세부 사항을 더욱 발전시켜 나갈 예정이다.