{"id":23181544,"url":"https://github.com/ron96g/oas-linter","last_synced_at":"2026-02-16T17:31:25.859Z","repository":{"id":265657096,"uuid":"896418797","full_name":"ron96G/oas-linter","owner":"ron96G","description":"Editor-UI-Suite with JSON-schema support and API to lint OpenAPI Specification (OAS) files. Uses Spectral to check OAS based on rulesets","archived":false,"fork":false,"pushed_at":"2025-03-10T09:13:11.000Z","size":2906,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T03:15:48.056Z","etag":null,"topics":["bun","json-schema","linter","oas","openapi","openapi-specification","spectral","swagger","swagger-ui"],"latest_commit_sha":null,"homepage":"https://ron96g.github.io/oas-linter/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ron96G.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-30T10:06:51.000Z","updated_at":"2025-03-10T09:13:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"772965f9-7112-4511-84de-fcd453ecf6e4","html_url":"https://github.com/ron96G/oas-linter","commit_stats":null,"previous_names":["ron96g/oas-linter"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ron96G/oas-linter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ron96G%2Foas-linter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ron96G%2Foas-linter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ron96G%2Foas-linter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ron96G%2Foas-linter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ron96G","download_url":"https://codeload.github.com/ron96G/oas-linter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ron96G%2Foas-linter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29513941,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T09:05:14.864Z","status":"ssl_error","status_checked_at":"2026-02-16T08:55:59.364Z","response_time":115,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bun","json-schema","linter","oas","openapi","openapi-specification","spectral","swagger","swagger-ui"],"created_at":"2024-12-18T08:16:34.221Z","updated_at":"2026-02-16T17:31:25.842Z","avatar_url":"https://github.com/ron96G.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OAS Linter\n\n[Example](https://ron96g.github.io/oas-linter/?ruleset=default\u0026schema=openapi.v3.0\u0026input=https://petstore3.swagger.io/api/v3/openapi.json)\n\n## Description\n\nThis project is a linter for OpenAPI Specification (OAS) files. It will check the OAS for errors and provide feedback on how to fix them.\nTo do this it uses [Spectral](https://stoplight.io/open-source/spectral/), a JSON/YAML linter that can be used to lint OAS.\n\nThis project is divided into two parts:\n- The backend is a REST API that receives the OAS and returns the linting results.\n- The frontend is a web application that allows the user to upload, edit and view the OAS. It will display the linting results and may also be used to display the [swagger-ui](https://swagger.io/tools/swagger-ui/) of the OAS.\n\n\u003e The frontend is a standalone application that can be used without the backend. If a backend exists, it will fetch the rulesets from the backend. **The frontend will never send the OAS to the backend.**\n\n## Backend\n\nBun-Application written using [Elysiajs](https://elysiajs.com/). It offers different endpoints:\n- to lint an OAS\n- to get/list linted OAS\n- to get the rulesets\n- to get the schemas\n\n### Configuration\n\nIt can be configured using the yaml-files in the `config` folder. The following configuration options are available:\n\n| Field | Description | Default |\n|-------|-------------|---------|\n| `auth.enabled` | Enable authentication | `true` |\n| `auth.trustedIssuers` | List of trusted issuers | `[]` |\n| `ui.enabled` | Enable support for UI links in responses | `false` |\n| `ui.apiBase` | The basePath of the API. Used for links | `` |\n| `ui.url` | The URL on which the UI is running. Used for links | `` |\n| `api.url` | URL of the API. Used in the Swagger-UI | `` |\n| `rulesets` | List of Ruleset definition used for linting | `[]` |\n| `rulesets[].name` | Name of the ruleset | `` |\n| `rulesets[].url` | URL to the ruleset file | `` |\n| `rulesets[].refreshInterval` | Interval in seconds to refresh the ruleset | `0` |\n| `schemas` | List of JSON-schema definition used for linting | `[]` |\n| `schemas[].name` | Name of the schema | `` |\n| `schemas[].url` | URL to the schema file | `` |\n\n\n\u003e The config-file can contains variables `${VAR_NAME}` that will be replaced by environment variables.\n\nThe name of the config-file must match the `NODE_ENV` environment variable.\n\n### Installation\n\nTo install the backend, run the following commands:\n\n```bash\ncd apps/backend\nbun install\n```\n\n### Running\n\nTo run the backend, run the following command:\n\n```bash\ncd apps/backend\nbun run dev\n```\n\n### Building\n\nTo build the backend, run the following command:\n\n```bash\nnpm run docker:build:server\n# or\nnpm run docker:build:all\n```\n\n## Frontend\n\nThe frontend is a standalone application that can be used without the backend. If a backend exists, it will fetch the rulesets from the backend. **The frontend will never send the OAS to the backend.**\n\nYou may use the [scripts](#scripts) to update the frontend assets.\n\nThe following query-parameters are supported:\n\n- `ruleset`: The name of the ruleset to use. If not set, the default ruleset will be used.\n- `schema`: The name of the schema to use. If not set, the default schema will be used.\n- `input`: The URL of the OAS to load, display and lint. **Requires CORS support.**\n- `showSwaggerUI`: If set, the swagger-ui will be displayed.\n\n### Installation\n\nTo install the frontend, run the following commands:\n\n```bash\ncd apps/frontend\nbun install\n```\n\n### Running\n\nTo run the frontend, run the following command:\n\n```bash\ncd apps/frontend\nbun run dev\n```\n\n### Building\n\nTo build the frontend, run the following command:\n\n```bash\nnpm run docker:build:ui\n# or\nnpm run docker:build:all\n```\n\n### Scripts\n\nThe following scripts can be used to update the frontend assets:\n\n- [update-swagger-ui](./apps//frontend/scripts/update-swagger-ui.js): This script will download the configured version of swagger-ui and copy the necessary files to the frontend assets folder.\n\n- [update-schemas](./apps/frontend/scripts/update-schemas.js): This script will download the schemas from the official OAS repository.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fron96g%2Foas-linter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fron96g%2Foas-linter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fron96g%2Foas-linter/lists"}