Opinionated API framework on top of Django REST framework
Project description
Thorgate API Core
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)
Transformer-based approach, inspired by djangorestframework-version-transforms and Stripe
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
0.2.0 (2018-04-14)
Added PageNotFoundView (JSON-based 404 views)
Added DetailSerializerViewSet (different serializers and queryset for list/detail/edit views)
Added CreateOnlyFieldsSerializerMixin, ModelValidationSerializerMixin and BaseModelSerializer
Renamed APIDocumentationView.get_patterns() to .urlpatterns()
Improved example app a lot. It now also includes tests that partially test tg-apicore itself
0.1.0 (2018-03-08)
First release on PyPI.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tg_apicore-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9eed2bc777df953dd01e424d5f357b44f1b001c2e184cb8946e674e52cf02720 |
|
MD5 | 0366dec7319f942a1d5b31a6ba5ed430 |
|
BLAKE2b-256 | bbaf85458f228206ad4a5c496b230b96a077e6b1d3176484f49c36faac4d3b17 |