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

response-openapi-validator

v2.0.2

Published

Asserts your responses using Swagger/OpenApi docs. Useful for API testing.

Downloads

192

Readme

response-openapi-validator

This library allows to match your existing response against your swagger/openapi docs.

  • Does lookup in your docs, and finds schema defined for provided response
  • Uses AJV to validate response body against found schema
  • Provides nice and clean errors
  • Framework/Stack agnostic (works with everything)
  • OpenApi v3 support is not yet verified
import { ResponseValidator } from "response-openapi-validator";

const validator = new ResponseValidator({
    // Also can be URL
    openApiSpecPath: "./.temp/open_api_docs.json",
});

const response = await got("http://someserver.com/api/something");

await validator.assertResponse({
    method: response.request?.options?.method,
    requestUrl: response?.request?.requestUrl,
    statusCode: response?.statusCode,
    body: response.body,
});

Option: ajvOptions

AJV is used to match found JSON schema against body. You can define AJV options by passing param:

const validator = new ResponseValidator({
    // Also can be URL
    openApiSpecPath: "./.temp/open_api_docs.json",
    // You can see all AJV options here
    // https://github.com/ajv-validator/ajv#options
    ajvOptions: {
        // I recommend to keep allErrors, verbose, and jsonPointers options enabled
        allErrors: true,
        verbose: true,
        jsonPointers: true,

        // Define additional JSON schema formats, if needed
        formats: {
            double: "[+-]?\\d*\\.?\\d+",
            int32: /^(-?\d{1,9}|-?1\d{9}|-?20\d{8}|-?21[0-3]\d{7}|-?214[0-6]\d{6}|-?2147[0-3]\d{5}|-?21474[0-7]\d{4}|-?214748[012]\d{4}|-?2147483[0-5]\d{3}|-?21474836[0-3]\d{2}|214748364[0-7]|-214748364[0-8])$/,
            int64: /^\d+$/,
        },
    },
});

Option: apiPathPrefix

Sometimes API has prefix part, which is not defined in docs.

Real path:

/core/user/create

Path defined in docs:

/user/create

You can specify such prefix in options:

const validator = new OpenApiValidator({
    apiPathPrefix: '/core'
    openApiSpecPath: "./.temp/open_api_docs.json",
});

await validator.assertResponse({
    method: response.request?.options?.method,
    requestUrl: response?.request?.requestUrl,
    statusCode: response?.statusCode,
    body: response.body,
});