Export Django models and serializers to TypeScript interfaces.
This tool allows you to easily export Django models and serializers as TypeScript interfaces, enabling better type safety and integration between Django backend and TypeScript frontend applications.
- Export Django models to TypeScript interfaces.
- Export Django REST Framework serializers to TypeScript interfaces.
- Support for various Django field types.
- Generates TypeScript enums for Django model choices.
- Supports both
modelsandserializersas the source. - Logs any fields that cannot be determined.
| Type | Models | Serializers | Expected Value |
|---|---|---|---|
| CharField | ✓ | ✓ | string |
| IntegerField | ✓ | ✓ | number |
| BooleanField | ✓ | ✓ | boolean |
| DateTimeField | ✓ | ✓ | string (ISO 8601) |
| DateField | ✓ | ✓ | string (ISO 8601) |
| DecimalField | ✓ | ✓ | number |
| UUIDField | ✓ | X | string |
| JSONField | ✓ | X | { [key: string]: any } |
| ForeignKey | ✓ | ✓ | RelatedModel / RelatedSerializer |
| ManyToManyField | ✓ | ✓ | RelatedModel[] / RelatedSerializer[] |
| OneToOneField | ✓ | X | RelatedModel |
| FileField | ✓ | ✓ | File |
| Fields with choices | ✓ | ✓ | enum |
| PrimaryKeyRelatedField | X | ✓ | RelatedSerializer |
| ManyRelatedField | X | ✓ | RelatedSerializer[] |
| ListSerializer | X | ✓ | RelatedSerializer[] |
| SerializerMethodField | X | ✓ | inferred type or any |
pip install django-ts-exporterdjango-ts-exporter --outdir ./typescript --exclude info e2e --logs --source modelsdjango-ts-exporter --helpOutputs:
usage: django-ts-exporter [-h] [--outdir OUTDIR] [--exclude [EXCLUDE ...]] [--logs] [--source {serializers,models}] [-v]
Export Django models and serializers to TypeScript interfaces.
optional arguments:
-h, --help show this help message and exit
--outdir OUTDIR Output directory for the TypeScript files. (default: ./typescript)
--exclude [EXCLUDE ...]
List of apps to exclude from export. (default: [])
--logs Enable detailed logs. (default: False)
--source {serializers,models}
Source to export: serializers or models (default: serializers)
-v, --version show program's version number and exit
To export TypeScript interfaces from Django serializers:
django-ts-exporter --outdir ./typescript --exclude info e2e --logs --source serializersTo export TypeScript interfaces from Django models:
django-ts-exporter --outdir ./typescript --exclude info e2e --logs --source modelsTo run the tests, use the following command:
python -m unittest discover testsFeel free to open issues or submit pull requests on GitHub.
This project is licensed under the MIT License - see the LICENSE file for details.