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

swagmock-allof

v1.1.0

Published

Mock data generator for swagger api

Downloads

11

Readme

swagmock

Mock data generator for swagger api

This package is the same as https://github.com/subeeshcbabu/swagmock with this PR applied: https://github.com/subeeshcbabu/swagmock/pull/49

Note: Swagmock version 1.0.0 onwards requires Node.js v6+ ("engines": {"node": ">=6.x"}). Please use v0.0.x (say 0.0.5), if you want to run this module on any previous node.js versions.

Install

npm install swagmock

Usage

    let Swagmock = require('swagmock');
    let Mockgen = Swagmock(api, options);
    // api Can be one of the following.
    // 1) A relative or absolute path to the Swagger api document.
    // 2) A swagger api Object.
    // 3) A promise (or a `thenable`) that resolves to the swagger api Object.
    // Set the `validated` : `true`  in `options`, if the api Object is already validated
    // and dereferenced ($ref are resolved ).

Promise response:

    let responseMock = Mockgen.responses({}); //returns a promise that resolves to response mock
    responseMock.then(mock => {
        //Use mock here
    }).catch(error => {
        Assert.ifError(error);
    });

Callback style:


    Mockgen.responses({ path: '/somepath'}, (error, mock) => {
        Assert.ifError(error);
        //Use mock here
    });

Check the API for more details.

Example

Initialize the mock generator

    const apiPath = 'http://petstore.swagger.io/v2/swagger.json';
    let Assert = require('assert');
    let Swagmock = require('swagmock');
    let Mockgen = Swagmock(apiPath);

Response mock generation:

    mockgen.responses({
        path: '/pet/findByStatus',
        operation: 'get',
        response: 200
    }).then(mock => {
        console.log(mock); // This would print:
        // {
        //     "responses": [{
        //         "id": 2530624032210944,
        //         "category": {
        //             "id": 8200505595527168,
        //             "name": "r($vA&"
        //         },
        //         "name": "doggie",
        //         "photoUrls": ["p0x1", "6O)3*kO"],
        //         "tags": [{
        //             "id": 4590764340281344,
        //             "name": "WCTA6f!"
        //         }, {
        //             "id": -4614156653166592,
        //             "name": "e"
        //         }],
        //         "status": "pending"
        //     }]
        // }
    }).catch(error => {
        Assert.ifError(error);
    });

Parameters mock generation:


    mockgen.parameters({
        path: '/pet/findByStatus',
        operation: 'get'
    }).then(mock => {
        console.log(mock);//This would print:
        // {
        //     "parameters": {
        //         "query": [{
        //             "name": "status",
        //             "value": [ 'available', 'pending' ],
        //             "separator": "multi"
        //         }]
        //     }
        // }
    }).catch(error => {
        Assert.ifError(error);
    })

Check Examples for more details on mock generators.

API

Swagmock(api, [options])

  • api - (Object) or (String) or (Promise) - (required) - api can be one of the following.

    • A relative or absolute path to the Swagger api document.
    • A URL of the Swagger api document.
    • The swagger api Object
    • A promise (or a thenable) that resolves to the swagger api Object
  • options - (Object) - (optional) - Additional options to create the mock generator.

    • validated - Set this property to true if the api is already validated against swagger schema and already dereferenced all the $ref. This is really useful to generate mocks for parsed api specs. Default value for this is false and the api will be validated using swagger-parser validate.

responses

mockgen.responses(options, [callback])

This generates the mock response objects based on the options

  • options - (Object) - (required) - Options to control the mock generation.

  • callback - (Function) - (optional) - function (error, mock). If a callback is not provided a Promise will be returned.

options

  • path - (String) - (optional) - The path for which the response mock need to be generated. For example /pet/findByStatus, /pet etc. If a path is not specified, mock response will be generated for all the paths defined by the swagger api.

  • operation - (String) - (optional) - The operation for which the response mock need to be generated. For example get, post etc. If operation is not specified, mock response will be generated for all the operations defined by the swagger api.

  • response - (String) - (optional) - The response for which the response mock need to be generated. For example 200, 400, default etc. If response is not specified, mock response will be generated for all the responses defined by the swagger api.

  • useExamples - (Boolean)- (optional) - Should the generated mock make use of example values defined in your swagger.json. Note: invalid example values will create invalid mockdata!

parameters

mockgen.parameters(options, [callback])

This generates the mock parameters objects based on the options

  • options - (Object) - (required) - Options to control the mock generation.

  • callback - (Function) - (optional) - function (error, mock). If a callback is not provided a Promise will be returned.

options

  • path - (String) - (optional) - The path for which the parameters mock need to be generated. For example /pet/findByStatus, /pet etc. If a path is not specified, mock parameters will be generated for all the paths defined by the swagger api.

  • operation - (String) - (optional) - The operation for which the parameters mock need to be generated. For example get, post etc. If operation is not specified, mock parameters will be generated for all the operations defined by the swagger api.

requests

mockgen.requests(options, [callback])

This generates the mock request object based on the options. requests API resolves the parameters mock data to generate the request mock object useful for unit tests.

  • options - (Object) - (required) - Options to control the mock generation.

  • callback - (Function) - (optional) - function (error, mock). If a callback is not provided a Promise will be returned.

options

  • path - (String) - (optional) - The path for which the parameters mock need to be generated. For example /pet/findByStatus, /pet etc. If a path is not specified, mock parameters will be generated for all the paths defined by the swagger api.

  • operation - (String) - (optional) - The operation for which the parameters mock need to be generated. For example get, post etc. If operation is not specified, mock parameters will be generated for all the operations defined by the swagger api.

data

request Object will have following possible properties query, header, pathname, path, formData or body based on the parameters defined for the path and operation.

Mock request Path templates are resolved using path parameters.

    mockgen.requests({
        path: '/pet/findByStatus',
        operation: 'get'
    }, function (error, mock) {
        assert.ifError(error);

        console.log(mock);
        //This would print:
        // {
        //     "request": {
        //         "query": "status=available&status=pending"
        //     }
        // }
    });

Examples

API

Usage

Unit test request mocks

github api express app

slack api hapi app

Mock response data providers

spotify api hapi app

glugbot api express app