OpenAPI와 llms.txt
기계가 읽을 수 있는 API 설명.
두 파일이 API를 기계가 읽을 수 있는 형태로 설명해요: 코드 생성기와 API 클라이언트용 openapi.json, AI 에이전트용 llms.txt.
openapi.json
OpenAPI 3.0 형식의 명세는 엔드포인트와 주요 파라미터, 응답, 오류, 인증을 설명해요. 웹훅이 전달하는 이벤트도 다뤄요. 세부 사항은 이 문서가 기준이에요.
URL
https://handelsregister.ai/openapi.json
활용 방법:
- OpenAPI Generator 같은 생성기로 내 언어용 타입 클라이언트를 만들어요.
- Postman, Insomnia, Bruno에 파일을 가져오면 모든 요청을 바로 쓸 수 있어요.
- 에이전트 프레임워크는 이 파일로 언어 모델용 도구 정의를 만들어요.
브라우저에서 URL을 열고 파일을 저장해 가져오세요.
버전 1 안에서는 새 필드와 값이 추가되고 기존 것은 유지돼요. 클라이언트가 알 수 없는 필드를 무시하도록 만드세요. 자세한 내용은 변경 이력에 있어요.
llms.txt
llms.txt는 언어 모델을 위해 API를 짧은 텍스트로 요약해요: 엔드포인트, 파라미터, 기능, 가격, 가장 중요한 규칙.
URL
https://handelsregister.ai/llms.txt
AI 에이전트가 API용 코드를 쓰기 전에 URL을 주세요. 그러면 실제 파라미터 이름과 응답 필드를 알게 돼요.