https://github.com/postman-open-technologies/openapi-linter

An open source implementation of Spectral for applying linting rules to an OpenAPI which can be deployed to AWS, Azure, and Heroku.
https://github.com/postman-open-technologies/openapi-linter

linting linting-rules openapi openapi3 spectral

Last synced: 9 days ago
JSON representation

An open source implementation of Spectral for applying linting rules to an OpenAPI which can be deployed to AWS, Azure, and Heroku.

• Host: GitHub
• URL: https://github.com/postman-open-technologies/openapi-linter
• Owner: postman-open-technologies
• License: apache-2.0
• Created: 2021-11-23T21:07:39.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-07T18:18:19.000Z (almost 3 years ago)
• Last Synced: 2024-04-14T16:07:40.068Z (7 months ago)
• Topics: linting, linting-rules, openapi, openapi3, spectral
• Language: TypeScript
• Homepage: https://api.linting.org/?rulesUrl=https://rules.linting.org/rulesets/base/
• Size: 927 KB
• Stars: 9
• Watchers: 2
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# spec-linter

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fpostman-open-technologies%2Fopenapi-linter%2Fmain%2Fdeployments%2Fazure-functions%2Ftemplate.json)

[Deploy to AWS](https://us-east-2.console.aws.amazon.com/cloudformation/home?region=us-east-2#/stacks/create/template?stackName=spec-linter-api&templateURL=https://public-spec-linter-api.s3.us-east-2.amazonaws.com/template.json)

An API for linting OpenAPI, AsyncAPI, and other JSON/YAML documents, built on top of [Spectral](https://github.com/stoplightio/spectral).

## 🛠 Usage

See the published [Postman Collection](https://www.postman.com/postman/workspace/openapi-linting/documentation/12959542-93cd90de-9f3c-4ed0-9c57-cc5a7712cf19) for more information on interacting with the spec-linter API.

Spectral config must be hosted at a URL. This API supports configuration in the following forms:

- JSON/YAML file

- Spectral JavaScript configuration (alpha, typically `.spectral.js`)

- Spectral TypeScript configuration (alpha, typically `.spectral.ts`)

## 🙏 Thanks

This project wouldn't be possible without the efforts of [Stoplight](https://stoplight.io/open-source/spectral/) and the [Spectral contributors](https://github.com/stoplightio/spectral/graphs/contributors).

## 📄 License

Apache-2.0