https://github.com/salexkidd/restframework-definable-serializer

restframework-definable-serializer
https://github.com/salexkidd/restframework-definable-serializer

django json restframework-serializer serializer yaml

Last synced: about 1 year ago
JSON representation

restframework-definable-serializer

• Host: GitHub
• URL: https://github.com/salexkidd/restframework-definable-serializer
• Owner: salexkidd
• License: mit
• Created: 2017-10-09T09:25:00.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-01-14T04:38:57.000Z (over 1 year ago)
• Last Synced: 2025-03-28T13:44:54.593Z (about 1 year ago)
• Topics: django, json, restframework-serializer, serializer, yaml
• Language: Python
• Homepage:
• Size: 1.27 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![CircleCI](https://circleci.com/gh/salexkidd/restframework-definable-serializer/tree/master.svg?style=svg)](https://circleci.com/gh/salexkidd/restframework-definable-serializer/tree/master) ![RTD](https://media.readthedocs.org/static/projects/badges/passing.svg)

# 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

- django>=1.11 or django>=2.2.7

- djangorestframework>=3.7.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

```

2. 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](http://restframework-definable-serializer.readthedocs.io/ja/latest/)

## Translation

[Transifex(https://www.transifex.com/restframework-definable-serializer/restframework-definable-serializer-documentation/dashboard/)](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](https://github.com/salexkidd/restframework-definable-serializer-example)