OpenAPI
OpenAPI YAML은 아래 경로에서 제공합니다.
https://developers.runmoa.com/openapi.yaml로컬 개발 중에는 빌드 산출물의 /openapi.yaml로 복사됩니다.
사용 방법
섹션 제목: “사용 방법”curl -L https://developers.runmoa.com/openapi.yamlOpenAPI 파일은 외부 문서, SDK 생성, API 검사 도구, AI 검색용 컨텍스트에 사용할 수 있습니다.
문서와 OpenAPI의 역할
섹션 제목: “문서와 OpenAPI의 역할”| 자료 | 용도 |
|---|---|
| 문서 페이지 | 사람이 읽는 설명, 흐름, 주의 사항 |
openapi.yaml | 엔드포인트 목록과 인증 방식의 기계 판독용 표현 |
llms.txt | AI 도구가 읽기 좋은 문서 지도 |
llms-full.txt | AI 도구에 바로 넣을 수 있는 압축 문서 본문 |
OpenAPI는 실제 등록된 외부 API 표면만 포함해야 합니다. 내부 라우트명이나 더 이상 쓰지 않는 로그인/결제 경로를 문서화하지 않습니다.