[스프링부트(SpringBoot)] API 문서 설계 예시

 

 

 

API 설계 문서를 표로 간단히 나타낼 수 있습니다. 다음은 주요 엔드포인트를 표 형식으로 정리한 예시입니다:

 

 

회원가입	POST	/users/signup	없음	{ "username": "...", "email": "...", "password": "..." }	{ "userId": 123, "username": "...", "email": "..." }
로그인	POST	/users/login	없음	{ "email": "...", "password": "..." }	{ "accessToken": "...", "refreshToken": "..." }
To-Do 생성	POST	/todos	Authorization: Bearer ...	{ "title": "...", "description": "...", "dueDate": "..." }	{ "id": 1, "title": "...", "description": "...", "dueDate": "...", "status": "..." }
To-Do 조회	GET	/todos	Authorization: Bearer ...	없음	[ { "id": 1, "title": "...", "description": "...", "dueDate": "...", "status": "..." }, ... ]
To-Do 수정	PUT	/todos/{id}	Authorization: Bearer ...	{ "title": "...", "description": "...", "dueDate": "...", "status": "..." }	{ "id": 1, "title": "...", "description": "...", "dueDate": "...", "status": "..." }
To-Do 삭제	DELETE	/todos/{id}	Authorization: Bearer ...	없음	없음

 

 

에러 응답 형식

상태 코드메시지설명

400	Bad Request	잘못된 요청
401	Unauthorized	인증 실패
403	Forbidden	권한 없음
404	Not Found	리소스를 찾을 수 없음
500	Internal Server Error	서버 오류

---

이 방식은 엔드포인트를 한눈에 보기 쉽고, 전체 구조를 간단히 이해하는 데 적합합니다. 더 구체적인 내용은 별도 섹션으로 추가하면 됩니다.