Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/natura-cosmeticos/api-linter
A comprehensive API linter for swagger files following Natura Cosmeticos best practices
https://github.com/natura-cosmeticos/api-linter
Last synced: about 5 hours ago
JSON representation
A comprehensive API linter for swagger files following Natura Cosmeticos best practices
- Host: GitHub
- URL: https://github.com/natura-cosmeticos/api-linter
- Owner: natura-cosmeticos
- License: mit
- Created: 2020-01-15T13:08:20.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-25T15:51:08.000Z (about 2 months ago)
- Last Synced: 2024-10-06T11:45:19.218Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@naturacosmeticos/api-linter
- Size: 888 KB
- Stars: 1
- Watchers: 7
- Forks: 4
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @naturacosmeticos/api-linter
[](https://travis-ci.org/natura-cosmeticos/api-linter) [](https://github.com/semantic-release/semantic-release)  [](https://snyk.io/test/github/natura-cosmeticos/api-linter)
A comprehensive API linter for swagger files using OpenAPI 3.0 following Natura Cosmeticos best practices
## Installation
```sh
# with npm
npm install --save @naturacosmeticos/api-linter
# with yarn
yarn add @naturacosmeticos/api-linter
```
## Usage
```javascript
const path = require('path');
const { validate } = require('@naturacosmeticos/api-linter');
const swaggerFile = path.join('path', 'to', 'swagger', 'file.yml');
/**
* Optional rules object for disabling/enabling rules
*/
const options = {
"must-contain-port": true,
"must-contain-server-url": true,
"no-singular-resource": true,
"must-contain-version": true,
"must-contain-domain-and-context": true,
"resource-spinal-case": true,
"no-custom-media-type": true,
"must-contain-media-type-version": true
};
const promise = validate(swaggerFile, options);
promise.then(faults => {
console.log(faults);
}).catch(err => {
console.error(err);
});
```
## CLI
```sh
$ npm install -g @naturacosmeticos/api-linter
$ api-linter --help ## For options
$ api-linter --file=/path/to/swagger.yml ## Basic usage
```
## Rules
These are the rules checked by the linter
```javascript
{
/**
* Checks for missing port number on server url, defaults to `true`
*/
"must-contain-port": boolean;
/**
* Checks for server url properties, defaults to true
*/
"must-contain-server-url": boolean;
/**
* Allow resource names in singular, defaults to `true`
*/
"no-singular-resource": boolean;
/**
* Checks for missing version number on server url, defaults to `true`
*/
"must-contain-version": boolean;
/**
* Checks for missing `/domain/context` on server url, defaults to `true`
*/
"must-contain-domain-and-context": boolean;
/**
* Checks for resources not using spinal case
*/
"resource-spinal-case"?: boolean;
/**
* Checks for main media types defined in RFC 6838, defaults to `true`
*/
"no-custom-media-type"?: boolean;
/**
* Checks for the presence of version parameter on vendor specific media types
*/
"must-contain-media-type-version"?: boolean;
}
```