https://github.com/afiore/apidoctor

A simple cli tool to santity check openAPI specs
https://github.com/afiore/apidoctor

Last synced: about 1 month ago
JSON representation

A simple cli tool to santity check openAPI specs

• Host: GitHub
• URL: https://github.com/afiore/apidoctor
• Owner: afiore
• License: mit
• Created: 2021-12-14T09:03:41.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-17T20:33:39.000Z (over 4 years ago)
• Last Synced: 2026-01-01T23:17:54.739Z (5 months ago)
• Language: Rust
• Size: 72.3 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 👩‍⚕️ APIDoctor

 A cli tool to sanity check OpenAPI specs

## Usage

```

apidoctor-lint 0.1.0

USAGE:

    apidoctor lint [FLAGS] [OPTIONS] 

FLAGS:

    -h, --help       Prints help information

    -s, --summary    Display only linting counts, omitting detailed messages

    -V, --version    Prints version information

    -w, --watch      Watch spec file for changes

OPTIONS:

    -o, --operation-id     Filter issue by the given operation id

    -t, --tags ...                 Filter issue by the given set of tags

ARGS:

        path to JSON or YAML spec

```

### Available linters

Currently the following linters have been implemented, and are always executed.

- example request/response payloads that fail schema validation.

- operations that have have a request/response schema, but no example payloads.

- presence of key metadata: description/summary and tags

### ⚠️ Warning

This project is at an early development stage, and might not be actively maintained in the future.