Welcome to Mirror API documentation!¶
mirror-api¶
Overview¶
An API that returns the structure of the request as the response.
If you send it a request with any method to any path besides /docs
,
it will return a response matching the structure of the request.
This is useful as a sample server to test infrastructure and ensure that requests are being sent and received as expected.
Getting Started¶
Install mirror-api
:
pip install mirror-api
Simply run the mirror-api
command to start the server. To see all available
options, run mirror-api --help
.
Links¶
See the documentation here.
Development Status¶
This project is currently in early-stage development. There may be breaking changes often. While the major version is 0, minor version upgrades will often have breaking changes.
Developing¶
See the development guide for development details.