Snack(스낵) API 문서 링크 : https://api.5nack.site/api-docs/

🧾 Swagger 컨벤션 & 체크리스트

✅ Convention (스웨거 컨벤션)

📋 Todo (할 일 목록)

1. 태그에 설명 작성하기

2. 각 API에 Description 작성

• Swagger 문서 내 각 endpoint의 description을 명확하게 작성
• 어떤 기능인지, 주요 동작이 무엇인지 간단하게 설명

3. Swagger 문서와 실제 동작 일치 여부 확인

확인 대상:

• [ ] Parameter: 쿼리, 경로, 바디 파라미터가 실제 요청과 일치하는지
• [ ] 응답 본문: 응답 형식이 실제 서비스 로직과 맞는지
• [ ] 경로(route): 실제 라우팅 경로와 Swagger 문서가 일치하는지

<aside> 💡

AI에게 route, controller, service, repository, 응답 본문을 넘겨준 이후에 ‘더 필요한 정보가 있다면 알려줘’라고 프롬프트 작성

</aside>