Thorgate API Core

https://img.shields.io/pypi/v/tg-apicore.svg https://img.shields.io/travis/thorgate/tg-apicore.svg Documentation Status

Opinionated API framework on top of Django REST framework

  • Free software: ISC license

See example directory for a demo on how to use it.

Supports Python 3.5+, Django 1.11+, Django REST framework 3.6+

Features

  • API documentation automatically generated from your views
    • General intro can be added
    • You can add example request/response data
    • Autogenerated Python requests-based examples
    • Not interactive yet
  • Integrates JSON API
    • Cursor pagination with configurable page size
  • Viewset classes for using different serializers and querysets for list/detail/edit endpoints
  • API-specific 404 view
  • Test utilities, e.g. for response validation
  • Versioning (WIP)

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.