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

swagger-fakeapi

v0.7.0

Published

Run contract (Swagger 2.0) based server that generates fake data.

Downloads

204

Readme

swagger-fakeapi

Run a contracts (Swagger 2.0) based server that generates fake data.

Install

$ npm install swagger-fakeapi

Usage

Extended X- properties support

The mocker understands a few extention properties which allow defining things that a vanilla Swagger contract would otherwise not allow.

x-mocker-format

The mocker tries to guess what style a value should be based on the type, format, and names of the property and the object's property ancestry. This allows you to override that and direct the mocker to any of the mock-types the API supports. As-is, this is only really useful for strings. The current list of values is:

  • city
  • country
  • currency
  • date
  • dateTime
  • email
  • firstName
  • id
  • imageUrl
  • lastName
  • locale
  • middleName
  • paragraph
  • path
  • phoneNumber
  • slug
  • title
  • type
  • url
  • uuid
  • word

This example schema:

User:
  required:
    - username
    - password
  properties:
    username:
      type: string
      x-mocker-format: email
    password:
      type: string
      x-mocker-format: id

Will generate:

{
  "username": "[email protected]",
  "password": "X5DCG1H"
}

x-mocker-keyformat

In the scenario where a contract allows additionalProperties the Swagger API does not define any means of control over what the actuall properties themselves look like, only the values. The mocker defaults to producing slug-like keys but this property corresponds to x-mocker-format and allows control over the generated keys' format.

This example schema:

Article:
  required:
    - title
    - date
  properties:
    title:
      type: string
    date:
      type: string
      format: date
  additionalProperties:
    x-mocker-keyformat: id
    required:
      - key
      - value
    properties:
      key:
        type: string
      value:
        type: string

Will generate:

{
  "title": "Ruworuma a y ykeba sofimi",
  "date": "2010-10-12",
  "X5DCG1H": { ... }
}

x-mocker-value

Allows control over the returned output in the cases where the mocker should repeat values of path or query parameters, or other values from the schema.

This comes in 4 flavours:

  • x-mocker-value: "#name"

    returns the parameter name as the value: { "title": "title" }

  • x-mocker-value: "#key"

    returns the first ancestor parameter name as the value:

    {
      "X5DCG1H": {
        "id": "X5DCG1H"
      }
    }
  • x-mocker-value: "?queryParam"

    returns the value of the query parameter corresponding to the name following the question mark.

  • x-mocker-value: "{pathParam}"

    returns the value of the path parameter corresponding to the name enclosed in the brackets.