멘토님이 Swagger & 자동화 강하게 강조 하셔서 이 페이지는 더 이상 갱신하지 않겠습니다!

Swagger와 깃허브 마크다운 문서 Github 마크다운 문서로 관리하겠습니다

<aside> <img src="/icons/document_green.svg" alt="/icons/document_green.svg" width="40px" />

API 명세서

• 백엔드 백로그에서 완료 버튼을 눌러 자신의 백로그가 검토로 가게 되면, 수 초 후 자동으로 API 명세서에 초안이 추가됩니다
  • 초안이 추가되면 노션에서 자동으로 알림이 가게 되므로 마저 명세해주시길 바랍니다!
  • 기본적으로 자동 생성 시 Status는 작성전으로 할당됩니다. 명세 완료 후 서버 미반영으로, 서버 반영 완료 후 반영 완료로 변경해주시길 바랍니다
  • Branch는 작성된 Endpoint에 따라 자동 계산됩니다. (함수이기 때문에 직접 수정 불가함)
• 명세 시 Method, Endpoint, Needs Token? RequestDTO, ResponseDTO 속성은 필수로 작성해주시길 바랍니다
  • Needs Token?은 Authentication에 액세스 토큰이 필요한지 여부를 적어두는 것이고, 만약 DTO가 없다면 공란으로 비워두시면 됩니다
  • 명세 시 좀 더 편할 수 있도록 API 명세 양식을 만들어두었습니다. API 명세 페이지에 들어가면 보일텐데 안쓰셔도 상관은 없습니다
• DTO 관리를 위해 하단에 DTO 리스트를 만들었습니다
  • DTO 작성 시 좀 더 편할 수 있도록 DTO 명세 양식을 만들었습니다. DTO 명세 페이지에 들어가면 보일텐데 안쓰셔도 상관은 없습니다
  • 색인을 위해 Category, Type 속성을 만들었습니다. 적절한 Cateogory가 없다면 추가 가능합니다 </aside>

API 명세 초안

잔디_final_API

잔디_final_DTO