단축키
- Cmd / Ctrl + S
- 현재 문서를 저장합니다.
- Cmd / Ctrl + D
- 기존 파일 연결 없이 새 문서를 엽니다.
- Opt / Alt + V
- 미리보기 패널을 열고 닫습니다.
- Opt / Alt + R
- 입력 중인 내용을 처음 상태로 되돌립니다.
- Esc
- 열린 메뉴나 팝업을 닫습니다.
저장 / 파일 위치
홈에서 먼저 작업 폴더를 선택해야 문서를 작성하고 저장할 수 있습니다.
같은 탭 세션에서는 새로고침해도 선택한 폴더를 다시 복구합니다.
- *.md
- 각 문서의 본문 파일입니다.
API 명세서는 선택한 폴더의 veldoc/api 안에 Path 기준 파일명으로 생성됩니다.
- veldoc-auth-policies.json
- 적용 범위별 Role 후보 목록만 저장하는 VelDoc 관리 파일입니다.
문서 저장 시 veldoc/api 안에 함께 정리됩니다.
문서 구조
왼쪽 문서 구조는 Markdown 문서의 Path와 Method를 기준으로 묶습니다.
같은 그룹 안에서 루트 API인 / 항목은 항상 위쪽에 배치됩니다.
작성 가이드
GET은 조회, POST는 생성, PUT은 전체 수정, PATCH는 일부 수정, DELETE는 삭제에 사용합니다.
POST, PUT, PATCH는 Body 입력을 함께 사용합니다.
Headers 표에는 API 계약에 필요한 값만 작성합니다.
자주 쓰는 헤더는 Headers 표 위 버튼으로 추가할 수 있습니다.
Authorization은 인증을 처음 켤 때 인증 방식에 맞춰 생성됩니다.
Body를 사용하는 메서드는 Content-Type이 자동으로 생성됩니다.
Accept는 기본값으로 */*를 사용합니다.
