KDID API Documentation
이 문서는 KDID 백엔드 API의 함수 사용법을 프론트엔드 개발자에게 설명합니다.
문서 구조
docs/
├── index.md # 홈 (기본 정보)
├── common/ # 공통 API
├── company/ # 건설 24 > 회사 관리
├── site/ # 건설 24 > 현장 관리
├── finance/ # 건설 24 > 재무 관리
├── safety/ # 건설 24 > 안전 관리
├── workmaru/ # 워크마루 API
├── dev/ # 관리자 API
├── requests/ # API 요청
│ ├── index.md # 요청 목록 및 사용 방법
│ └── _template.md # 요청 작성 템플릿
├── system/ # 시스템 API
└── _references/ # 참조 자료
├── request-response.md # 공통 요청/응답 형식
├── test-mode.md # 테스트 모드
├── template.md # 문서 작성 템플릿
├── enums.md # ENUM 값 목록
├── regex.md # REGEX 패턴
└── error-codes.md # 에러 코드
건설 24 사이드바 구조
건설 24
├── 회사 관리
│ ├── 회사 설정 (5개)
│ ├── 직원 입사/퇴사 (5개)
│ ├── 출퇴근 관리 (11개)
│ └── 현장 감독 (2개)
├── 현장 관리
│ ├── 현장 설정
│ │ └── 등록/상태 (4개)
│ ├── 인력 관리
│ │ ├── 입사/퇴사 (5개)
│ │ ├── 현장 변경 (4개)
│ │ └── 출퇴근 (10개)
│ ├── 장비 관리
│ │ ├── 배정/해제 (4개)
│ │ ├── 현장 변경 (3개)
│ │ └── 출퇴근 (9개)
│ └── 작업 관리
│ ├── 작업 (10개)
│ ├── 첨부파일 (3개)
│ ├── 특이사항 메모 (2개)
│ ├── 폐기물 (5개)
│ └── 자재 (5개)
├── 재무 관리
│ ├── 노임대장 (6개)
│ ├── 장비대 (7개)
│ ├── 자재비 (6개)
│ └── 기타 비용 (7개)
└── 안전 관리
├── 위험성 평가 (2개)
├── 작업 중지 (2개)
└── 비상/제안 (2개)
API 요청 문서 작성
프론트엔드에서 백엔드에 새 API 구현을 요청할 때 사용합니다.
작성 방법
docs/requests/_template.md를 복사- 파일명을 API 이름으로 변경 (예:
upload_profile_image.md) - 템플릿 내용 작성:
- 상태:
요청됨으로 시작 - 요청 배경: 왜 필요한지
- 기대하는 기능: 무엇을 해야 하는지
- 제안하는 API 스펙: 엔드포인트, Request, Response
docs/requests/index.md의 요청 목록 테이블에 추가- PR 생성하여 리뷰 요청
상태 값
| 상태 | 설명 |
|---|---|
요청됨 |
요청 등록됨 |
검토중 |
백엔드 검토 중 |
승인됨 |
구현 예정 |
개발중 |
개발 진행 중 |
완료 |
구현 완료 |
완료 후 처리
구현이 완료되면 요청 문서를 해당 서비스 폴더로 이동합니다.
- 건설24 관련: company/, site/, finance/, safety/
- 워크마루 관련: workmaru/
- 공통: common/