Skip to main content
PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

restframework-definable-serializer

Project description

CircleCI RTD

restframework-definable-serializer

restframework-definable-serializer is definable serializer by JSON or YAML format.

Feature

  • It can define restframework serializer by JSON or YAML
  • It can write and modify serializer by django admin pages.

Dependencies

  • python>=3.12
  • django>=4
  • djangorestframework>=3.15.0
  • django-codemirror2>=0.2
  • django-jsonfield>=1.0.1
  • django-yamlfield>=1.0.3
  • PyYAML>=5.2
  • ruamel.yaml>=0.13.5
  • simplejson>=3.11.1
  • six>=1.13.0

Quick start

  1. Install restframework-definable-serializer
pip install restframework-definable-serializer
  1. Add "definable_serializer" and "codemirror2" to your INSTALLED_APPS setting like this:
INSTALLED_APPS = [
    ...
    'definable_serializer',
    'codemirror2',
]

Documentation

For extensive Japanese documentation see the docs read it on Readthedocs

Translation

Transifex(https://www.transifex.com/restframework-definable-serializer/restframework-definable-serializer-documentation/dashboard/) is used to manage translations.

Feel free to improve translations.

Currently supported languages are:

  • Japanese

You can request to add your own language directly on Transifex.

Sample code

You can try restframework-definable-serializer. See example_project

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page