Skip to main content

Simple mock server for REST API

Project description

Mock server

Simple mock server for REST and XML-RPC API

It can mock GET, POST, PUT, PATCH, DELETE and some more rarely used HTTP methods.

Build status at Travis CI: travis

DEMO

http://demo.mockapi.org/__manage

Installation

Install with pip:

$ pip install mock-server

Or install with easy_install:

$ easy_install mock-server

And after run:

$ mock-server --dir=/path/to/api

It will be listening on port 8888 and wait for your HTTP requests.

Overview

For create mock for url path go to:


Mocked GET /user/tom:

$ curl -v -X GET http://demo.mockapi.org/user/tom

> GET /user/tom HTTP/1.1
> Host: demo.mockapi.org
> Accept: */*
>
< HTTP/1.1 200 OK
< Access-Control-Allow-Origin: *
< Content-Type: application/json; charset=utf-8
< Content-Length: 64
< Server: TornadoServer/2.4.1
<
{
    "name": "Tom",
    "surname": "Smith",
    "age": 22
}

Features

  • Mocking REST API.

  • Mocking RPC API (xml, json).

  • Upstream server proxy (proxy an existing api).

  • Variables in url path.

  • Simple api documentation (markdown).

  • Api authentication (HTTP Basic authentication).

Format

response content format: %METHOD%_%STATUS%.%FORMAT%

response headers format: %METHOD%_H_%STATUS%.%FORMAT%

root_dir/
    GET_200.json         # response content for GET /
    GET_H_200.json       # headers for GET /
    user/
        DELETE_404.xml   # response content for DELETE /user.xml?__statusCode=404
        POST_200.json    # response content for POST /user
        POST_H_200.json  # headers for POST /user

Bug report

If you have any trouble, report bug at GitHub Issue https://github.com/tomashanacek/mock-server/issues

Contributors

William Zhang

History

0.3.3

  • create resource quotation character fix

0.3.2

  • todo escaping fix

0.3.1

  • support for todos in api documentation

  • access log improvements

0.3

  • upstream server proxy (proxy an existing api)

  • variables in url path

  • simple api documentation (markdown)

  • api authentication (HTTP Basic authentication)

  • manage interface improvements

No notes on earlier releases.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mock-server-0.3.3.tar.gz (338.8 kB view details)

Uploaded Source

File details

Details for the file mock-server-0.3.3.tar.gz.

File metadata

  • Download URL: mock-server-0.3.3.tar.gz
  • Upload date:
  • Size: 338.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mock-server-0.3.3.tar.gz
Algorithm Hash digest
SHA256 09d9dda0c0fdb266d29c4e417eb3e164d5b86b8fb3cb8ea539c7f56adbc8cc49
MD5 6d05effba5698819c4cccf5aa946c8d6
BLAKE2b-256 faf328171be3481632ab64e3cbe30819a98fa3e90e164d328ac3d02c5ceed67f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page