api-oas-checker
api-oas-checker copied to clipboard
An OpenAPI 3 checker based on spectral.
## I expect To block processing problematic files: - [ ] binary files  - [ ] files containing tabs '\t' - [ ] the tab characters to be highlighted...
## I expect to selectively disable rules via a `# noqa` comment or flagging them in the GUI NB: SEE spectral 6.0.0 behavior before implementing ## Instead I can't ##...
## I expect to support OAS3-1 stuff in rules, eg. - [ ] MUST info.summary - [ ] MUST info.license.identifier ## Notes - This requires spectral 6.x
Some suggestions for additional rules: If OAuth is used, an `authorizationUrl`, `tokenUrl` (depending on the OAuth flow) and a `refreshUrl` as well as `scopes` should be specified (see https://swagger.io/docs/specification/authentication/oauth2/). The...
## I wish to consider some security hints stated here. - [ ] https://apisecurity.io/encyclopedia/content/oasv3/oasv3_audit.htm - [ ] https://github.com/shieldfy/API-Security-Checklist - [ ] missing required properties hint @berez23 Please file a list...
## Note Consider adding a rule to check for common [redos](https://en.wikipedia.org/wiki/ReDoS) patterns in regexp. The analysis shouldn't probably go that far, but some patterns (eg `*)*` are easy to find)....
This is a usability issue. The monaco editor demands to the user the updates on lines highlights
## I wish - to identify a score 0-100 mechanism to evaluate API compliance; - the score depends on the issue level (info, warning, error); - security and compliance should...
The [editor](https://microsoft.github.io/monaco-editor/) appaerance is customizable. We should improve the color scheme and the font in order to harmonize it on the page. cc: @Fupete