OpenAPI 린터
OpenAPI/Swagger 명세에서 일반적인 오류를 검사하고 검증하세요.
OpenAPI / Swagger (YAML 또는 JSON)
린트 결과
OpenAPI 문서를 붙여넣으면 린트 결과가 표시됩니다.
개선 제안
- 더 명확한 문서를 위해 각 작업에 요약/설명을 추가하세요.
- 중복을 피하기 위해 components.schemas 아래에 재사용 가능한 스키마를 정의하세요.
- 콘텐츠 스키마와 함께 명확한 2xx 응답을 포함하세요.
OpenAPI/Swagger 명세에서 일반적인 오류를 검사하고 검증하세요.
OpenAPI(구 Swagger)는 RESTful API를 기술하는 표준입니다. 이 페이지는 OpenAPI 문서를 lint하여 품질 문제를 사전에 발견하고, 일관되고 이해하기 쉬운 API 계약을 유지하도록 돕습니다.
OpenAPI 문서는 YAML 또는 JSON 형식으로 endpoint, method, parameter, request/response body, authentication, 재사용 가능한 components를 정의합니다. 명확하고 검증된 스펙은 문서화, 코드 생성, 테스트, 팀 간 거버넌스를 강화합니다.
Linter는 누락된 description, 모호한 상태 코드, 불일치한 schema, 재사용 가능한 components 기회를 검사합니다. 일관된 네이밍, 명확한 content type, 완전한 example을 권장하여 SDK 및 클라이언트 통합의 마찰을 줄입니다.
POST /users에 requestBody는 있지만 schema 또는 example이 없는 경우, Linting은 components.schemas.User 아래 JSON Schema 정의 추가와 $ref 참조를 제안하고, 201 및 400 응답에 example payload 문서를 권장합니다.
스펙을 붙여넣어 빠른 피드백을 받으세요. 설계 리뷰 및 CI 과정에서 활용하여 가독성과 도구 호환성을 유지하세요. Contract testing과 함께 사용하면 구현과 스펙 간 일치를 보장할 수 있습니다.
건강한 API 생태계는 고품질 스펙에서 시작합니다. Lint를 반복적으로 적용하여 개발자가 신뢰하는 문서와 SDK를 구축하세요.