8000 GitHub - alexkress/simple-testing-server: A stupidly simple python server that allows you to test client code before you have a server that actually works
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

A stupidly simple python server that allows you to test client code before you have a server that actually works

Notifications You must be signed in to change notification settings

alexkress/simple-testing-server

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 

Repository files navigation

simple-testing-server

A stupidly simple python server that allows you to test client code before you have a server that actually works Allows you to test json responses with the proper headers built in, and also custom error codes.

Motivation

So say you want to build some sort of app that connects to a client... great! But how are you going to deal with separating the development between the application logic and the backend api? Where are your api calls supposed to go before that server exists? Enter this project.

Example Usage

Start by spinning up the server using

python simple-testing-server.py --port <PORT> --path <PATH>

GET

This server uses json as the default object structe. Say you want to get an example json response from your server. Suppose you're modeling some data in your app. Let's call an example model events. Then

GET http://localhost:<PORT>/events

will return to you the contents of a file called events.json with proper headers. This file is up to you to create and place in the same folder as the python script.

More generally, GET http://localhost:<PORT>/<model_name> will return an application/json response with content taken from a file called <model_name>.json placed in the same folder as the script. BYO example json files. (use the --path options if these files are in a different directory)

if a file <model_name>.json does not exist, but a directory with the name <model_name> does. The code will list all files with .json extension and return a json list with the file names with the .json extension removed

POST

To make a post request with a successfull (200) response:

POST http://localhost:<PORT>/success

Want a failure (500)? Try

POST http://localhost:<PORT>/error

Those two response codes aren't good enough for you? Fine.

POST http://localhost:<PORT>/<response_code>

The body accepts parameters in application/x-www-form-urlencoded format.

Set Content-Type to application/x-www-form-urlencoded

POST http://localhost:<PORT>/any_url
p1=v1&p2=v2&p3=v3

The result is parsed and returned back as JSON

{
   "p2":"v2",
   "p3":"v3",
   "p1":"v1"
}

Persistence

All post requests will be persisted on disk. For example if a post is made to http://localhost:/abc, the code will try to create a file [random number].json with the content of what POST request also sends back to the client.

The client can then later request http://localhost:/abc/[same random number] to get back this result

There you have it.

Options

A list of command line options:

  • -h, --help - show a help message
  • -p <PORT>, --port <PORT> - run on a custom port
  • --path <PATH> - keep your sample data in a custom path

Compatibility

AFAIK all versions of python. If you don't have argparse installed, the custom port won't work and it will just default to PORT=8003 every time.

Authors

License

This program is free software. It comes without any warranty, to the extent permitted by applicable law. You can redistribute it and/or modify it under the terms of the WTFPL, Version 2, as published by Sam Hocevar. See http://sam.zoy.org/wtfpl/ for more details.

About

A stupidly simple python server that allows you to test client code before you have a server that actually works

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%
0