{"repo":"SchwarzIT/api-linter-rules","free":true,"listed":false,"github":"https://github.com/SchwarzIT/api-linter-rules","clone":"git clone https://github.com/SchwarzIT/api-linter-rules.git","description":"Schwarz API rule definitions for the Spectral API linter","language":"TypeScript","stars":29,"topics":["openapi","spectral","api","linting-rules"],"license":"Apache-2.0","category":"api-integrations-sdks","readme_excerpt":"api-linter-rules Schwarz API spectral custom rulesets to be used with Spectral Linter toolset. You can use this rules to integrate them in your own development workflow or you can build upon your own interpretation of how an API should look like. Rulesets are based on file inheritance on custom rulesets as supported by Spectral Rulesets assuming that different API types use the same ruleset but different severity levels as provided by Spectral Custom Rulesets. All API type specific rulesets depend on the same base ruleset files and just overwrite rulesets or severity levels. Example how to overwrite severity levels in spectral-api.yml: --- Base ruleset - Base ruleset is defined inside the asyncapi / openapi package and published as part of the latest release - Extends from spectral:oas recommended rules - Is generated by merging it with all individual rules at build time Supported API Types - Product API ruleset is defined in spectral-api.yml - Backend For Frontend is defined in spectral-bff.yml - Legacy API is defined in spectral-legacy.yml Local usage in IDE Visual Studio Code - Install Spectral Linter for VS Code - Copy rules in your repo and create VS Code settings as described in the plugin repo OR just reference the desired API type validation from this repository like shown underneath: 1. Create \"spectral.config.yml\" in the root of you repository and paste below content into it 2. Adapt VS Code settings in .vscode/settings.json 3. Place your open api spec in a folder c","default_branch":null,"files":null,"tree":[],"storefront":"/r/SchwarzIT","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/SchwarzIT/api-linter-rules/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}