- API 기술 문서 작성의 핵심 원칙과 실무 기법을 학습하는 실습 중심의 과정입니다.

과정 목표
- API 문서의 구조와 핵심 요소를 이해하고 효과적으로 작성할 수 있다.
- 개발자 친화적인 API 문서 작성 기술을 습득한다.
- API 문서화 도구를 활용하여 효율적으로 문서를 관리할 수 있다.

추천 대상
- API 문서 작성을 담당하는 개발자 및 테크니컬 라이터
- 프로젝트 매니저 및 제품 관리자
- API 설계 및 개발에 관여하는 IT 전문가

사전 체크리스트
- RESTful API의 기본 개념을 이해하고 있다.
- 기본적인 프로그래밍 지식이 있다.
- 마크다운(Markdown) 문법을 알고 있다.
- Git 버전 관리 시스템을 사용해 본 경험이 있다.
- API 테스트 도구(예: Postman)를 사용해 본 적이 있다.

체크리스트 결과
- 5개 중 2개 이상 "아니오"를 선택한 경우, 아래 사전 학습이 필요합니다:
  - 사전 학습 필요 지식:
    - RESTful API 기본 개념
    - JSON 데이터 구조
    - 기본적인 HTTP 메서드 및 상태 코드

강사 소개
- 별도 정보 없음

준비 사항
- 개인 노트북

교육 정보
- 장소: 한양대학교
- 기간: 1일 (14시간)
- 방식: 이론 10%, 실습 90%

평가 방식
- 객관식 8문항 (10점/문항)
- 서술형 2문항 (10점/문항)

수료 기준
- 출석 80% 이상
- 종합평가 60점 이상
- 총합 70점 이상 (출석 50%, 종합평가 50%)

교육 시간표
- **1일차**
  - 09:00~09:50: API 문서화 개요 및 중요성
  - 10:00~10:50: API 문서 구조 및 핵심 요소
  - 11:00~11:50: API 엔드포인트 설명 작성 실습
  - 11:50~13:00: 점심 식사
  - 13:00~13:50: 요청/응답 예제 작성 기법
  - 14:00~14:50: 에러 처리 및 상태 코드 문서화
  - 15:00~15:50: API 인증 및 보안 설명 작성
  - 16:00~16:50: Markdown을 활용한 API 문서 작성 실습

담당자명 : 미배정 / 연락처 :