디버거즈 API 사용 방법 안내

안녕하세요, 디버거즈 사이트 개발자이자 기획집행국원 이규연입니다.

이번 공지에서는 디버거즈 OpenAPI의 사용 방법에 대해 보다 상세하게 안내드리고자 합니다.

---

API 문서 위치

모든 API 엔드포인트와 사용법은 저희 사이트의 /docs 경로에서 확인하실 수 있습니다.

• 각 API의 목적, 요청 방법, 파라미터, 응답 예시 등이 상세하게 정리되어 있습니다.

---

요청 방법 및 메서드 안내

각 API 엔드포인트별로 어떤 HTTP 메서드 (GET, POST, DELETE, PATCH 등)를 사용해야 하는지,
그리고 요청 시 필요한 파라미터 와 응답 형식 이 /docs에 명확하게 안내되어 있습니다.

예를 들어:

• GET : 데이터 조회 (예: /api/notices로 공지 목록 조회)
• POST : 데이터 생성 (예: /api/feedback으로 피드백 제출)
• PATCH : 데이터 일부 수정 (예: /api/profile로 프로필 정보 일부 변경)
• DELETE : 데이터 삭제 (예: /api/post/{id}로 게시글 삭제)

각 엔드포인트별로

• 요청 URL
• 필수/선택 파라미터
• 요청/응답 예시
• 인증 필요 여부
  등이 /docs에 표로 정리되어 있으니, 반드시 참고해 주세요.

---

개발/테스트/임시 중지 API 표기 안내

• 아직 개발 중이거나, 테스트되지 않았거나, 임시로 사용이 중지된 API 의 경우
  /docs 문서 내에서 해당 API 이름 옆에 아래와 같이 상태가 명확하게 표기 되어 있습니다.

  • 예시:
    • POST /api/feedback (개발 중)
    • GET /api/score (임시 중지)
    • PATCH /api/user (테스트 미완료)

• 이 표기가 있는 API는 실제 서비스 환경에서 정상적으로 동작하지 않을 수 있으니, 사용 전 반드시 상태를 확인 해 주세요.

• 상태 표기는 실시간으로 업데이트되며,
  개발 완료/테스트 완료/서비스 재개 시 표기가 변경됩니다.

---

추가 안내

• API 사용 전 /docs를 꼭 확인 하여,
  최신 엔드포인트 정보와 사용법, 상태(개발/테스트/중지 등)를 숙지해 주세요.
• 문의나 피드백은 언제든 채널톡 으로 남겨주시면 빠르게 안내드리겠습니다.

감사합니다.