writing-openapi-specs

SKILL.md

Reference for OpenAPI best practices and conventions. This skill provides guidance on taste, conventions, and grey areas not covered by the OpenAPI specification itself.

Operation IDs: Use lowercase with underscores, following resourceaction pattern:

Component Names: Use PascalCase for schemas, parameters, and other reusable components:

OpenAPI 사양 모범 사례, 명명 규칙, 다형성, 열거형, 파일 업로드, 서버 전송 이벤트와 같은 복잡한 REST API 패턴 표현에 대한 참조 가이드입니다. OpenAPI 사양을 작성하거나 개선할 때 확립된 규칙을 따르고 고품질 SDK를 생성하는지 확인하는 데 사용합니다. 출처: speakeasy-api/agent-skills.

원본 보기