npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

openapi-contract-validator-server

v0.2.0

Published

Use an HTTP proxy to validate HTTP interactions against an OpenAPI Schema

Downloads

8

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

lakitnalakitna

Keywords

OpenAPI SchemaOpenAPIOAStestcontractcontract-basedproviderprovider-driven

Readme

OpenAPI Contract validator server

Validate HTTP interactions against an OpenAPI Schema via an HTTP proxy.

Installation

npm install -g openapi-contract-validator-server

Getting started

Make sure you've installed the package like described above.

You'll need a few config files. Open a command line in the folder you want to store the config files and execute:

openapi-contract-validator-server init

A few files have been generated for you:

  • endpoints.js is the place where you'll define all your endpoints and their corresponding contracts
  • openapi-contract-validator-server.config.js is the place where you can configure the server itself

All files contain default values. You can now start the server:

openapi-contract-validator-server start

Make a request to http://localhost:3000/ to see the server work.

Command line interface

> openapi-contract-validator-server --help
Usage: openapi-contract-validator-server <command> [options]

Options:
  -V, --version    output the version number
  -h, --help       display help for command

Commands:
  start [options]  Start a OpenAPI Schema validation proxy server.
  init             Copy default configuration to get started quickly
  help [command]   display help for command

start

You can overwrite some bits of server configuration by supplying them as command line flags.

> openapi-contract-validator-server start --help
Usage: openapi-contract-validator-server start [options]

Start a OpenAPI Schema validation proxy server.

Options:
  -p, --port <port number>  Start the server on this port
  -t, --target <url>        Target base URL
  -l, --log <depth>         Numeric level of log detail
  -c, --config-file <path>  Path to the config file that should be used
  -h, --help                display help for command
openapi-contract-validator-server start --target http://localhost:4200 -l 2

Contributing

Contributors are always welcome! I really don't care if you are a beginner or an expert, all help is welcome. Help includes code contributions, fixing one of my many typos, helping others, etc.