dino-api

This repository demonstrates the following engineering flow for API development:

1. Define new endpoint(s) in OpenAPI (found at api/docs/openapi.yaml)
2. Generate and run contract tests from spec (see here). They should fail.
3. Implement new endpoint(s)
4. Repeat Step 2. They should pass!

Building the Docker Image

To build the Docker image containing the API:

docker build -t dino-api:local .

Resetting the Database

To drop all data and start with a fresh (migrated) database:

rm db/db.sqlite3
docker run -v $(pwd)/db:/usr/app/db dino-api:local python manage.py migrate

Running the API

To run the API after migrating the database (see above):

docker run -p 8000:8000 -v $(pwd)/db:/usr/app/db dino-api:local

Viewing the API Docs:

To view the generated API documentation after starting the API (see above), navigate to localhost:8000/api/docs/.

Generating and Running Contract Tests

To run contract tests after starting the API (see above):

docker run \
  -v $(pwd)/api/docs:/api \
  apiaryio/dredd \
  dredd /api/openapi.yaml http://host.docker.internal:8000