Welcome to drf-microservice documentation!

About Drf-microservice

drf-microservice is a ready-to-use API skeleton:

• Cookiescutter-drf-microservice generated it,
• api endpoints, all are secured by login/token
• an api endpoint requires access authorization

And you:

• add your unittest and endpoints,

And it will help you to:

• generate the documentation with drf-yasg,
• test it with Tox,
• package it Docker,
• deploy it (TODO with) Terraform or Ansible

It sounds simple and it is. Take a look at Drf-microservice it's now generated by Cookiescutter-drf-microservice.

Something disturb you in the code? Don't hesitate to open a an issue and contribute.

docker-compose

# create image(s) described in the docker-compose.yml:

docker-compose build

# Builds, (re)creates, starts, and attaches to containers for a service:

docker-compose up -d

# Stops, all the containers for a service:

docker-compose down

urls:

xx.xx.xx.xx:8000
xx.xx.xx.xx:8000/admin/
xx.xx.xx.xx:8000/swagger/openapi/

Releases notes

Bugs and evolution policies

When you will find a bug or propose an evolution create a ticket on:

• Issue Cookiescutter-drf-microservice if it's about the generation process
• Issue Drf-microservice if it's about a functionality in the generated drf process

Online documentation is here on readthedoc Online source code available on Github