https://github.com/appear-sh/api-validator
An API validation tool that showcases our OAS Zod Validator alongside third-party validators and linters, providing a combined quality report for OAS 3.0.x and 3.1 specifications.
https://github.com/appear-sh/api-validator
api openapi-specification openapi3 openapi31 validator
Last synced: 10 months ago
JSON representation
An API validation tool that showcases our OAS Zod Validator alongside third-party validators and linters, providing a combined quality report for OAS 3.0.x and 3.1 specifications.
- Host: GitHub
- URL: https://github.com/appear-sh/api-validator
- Owner: appear-sh
- Created: 2025-04-28T02:35:04.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-04-29T00:56:10.000Z (10 months ago)
- Last Synced: 2025-04-29T01:26:19.175Z (10 months ago)
- Topics: api, openapi-specification, openapi3, openapi31, validator
- Language: TypeScript
- Homepage: https://validator.appear.sh
- Size: 194 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
OAS Zod Validator
An OpenAPI Spec Validator and Linting tool using opensource tools, including our OAS Zod Validator . From Appear.
Learn more »
Appear Website
·
Issues
·
Appear Product Map
# API Validator
An API Validator tool which exists to showcase our OAS Zod Validator tool in concert with third-party validators and linters to offer a blended report on the quality of your spec, supporting both OAS 3.0.x and 3.1 specifications.
[](https://opensource.org/licenses/MIT)
## Features
- Validates OpenAPI 3.0.x and 3.1 specs (YAML or JSON)
- Runs multiple open source validators (including OAS Zod Validator, Spectral, SwaggerParser) for a blended, comparative report
- Maps validation and linting errors directly to your uploaded spec, with clear path and message details
- Provides an interactive web UI for uploading, viewing, and exploring results—no CLI required
- Calculates an overall API quality score based on combined validator results
- Supports drag-and-drop or file browsing for spec upload
- Displays real-time feedback and progress during validation
- Highlights issues by severity (error, warning, info) and by source validator
- No external runtime dependencies required for the web app (all validation runs server-side)
## Getting Started
First, install dependencies:
```bash
npm install
```
Then, run the development server:
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see single page app.
## Usage
Drag an OpenAPI 3.x spec into the upload panel or browse for the spec on your machine. Once uploaded the tool will assess the spec against several linters and validators to provide a report.
## Project Status / Planned Work
- Adding more linting/validation tools
- UI tweaks
- Performance improvements
- Better hooks into Appear