Git Product home page Git Product logo

swagger-mocker's Introduction

Zwartpet\SwaggerMocker

Build Coverage Code Quality

Transform your Swagger (Open API) spec examples into a Symfony REST mock server

SwaggerBundle

This project uses the Kleijnweb\SwaggerBundle to provide the routes and definition validation.

Usage

Quick and simple

  1. Checkout the project and install dependencies
  2. Replace the content of web/swagger/default.json with the specification you want to mock
  3. Run the application with docker-compose

Use the docker image

Available here

Custom examples

By default it will use the examples specified in your definition. To be able to adjust the examples for each and every project you can add example files. As an example I've added such an example in the directory the examples should go. The files should be named as follows:

  • ROUTE_NAME + url parameter key=value + query params key=value
  • The url and query parameters are both ordered by alphabet by key and separated by an '&'
  • You can find the ROUTE_NAME by running app/console debug:router in the container

Eg:

url = /pets/{id}?debug=0&auth=1 // where id=1 and ROUTE_NAME=swagger.default.pets.id.findPetById
filename = swagger.default.pets.id.findPetById&id=1&auth=1&debug=0

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.