Giter VIP home page Giter VIP logo

spectral-report's Introduction

Spectral Report

Overview

spectral-report is a tool for linting and reporting openAPI specifications. It is built over @stoplight/spectral.

Installation

You can install spectral-report using npm:

npm install -g spectral-report

Usage

You can run spectral-report using command:

spectral-report -s "path-to-spec-file"

For more options:

Usage: spectral-report -s "path-to-spec-file" [-r "path-to-rule-file"] [-n "report-name"] [-f "report-format"]

Options:
  -v, --version                   output the current version
  -s, --specPath <openapi spec>   path to openapi specification
  -r, --rulesetpath <rule file>   path to rules file
  -n, --reportName <report name>  report name (default: "spectral-report")
  -f, --reportFormat <format>     report format (choices: "json", "html", "csv", default: json)
  -h, --help                      display help for command

License

This project is licensed under the MIT License - see the LICENSE file for details.

spectral-report's People

Contributors

ahemanna avatar dependabot[bot] avatar

Watchers

James Cloos avatar avatar

Forkers

paloaltonetworks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.