Skip to content

A test API written with Flask interfacing with MongoDB.

License

Notifications You must be signed in to change notification settings

jgoney/api-test

Repository files navigation

api-test

Prerequisites

  • Python 3.x
  • MongoDB 3.x
  • A Unix-based system if you'd like to use the Makefile commands

Getting started

Quickstart:

make  # runs setup, runs the tests, and starts the server

To setup the virtualenv and install requirements:

make setup

To populate the db and create indices:

make init-mongo

To start the server:

make run-server

To run tests:

make test  # runs tests
make coverage  # runs tests with coverage report

Using the API

Refer to the docstrings in server.py for more info on using each endpoint.

About

A test API written with Flask interfacing with MongoDB.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published