django-rest-tsg 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
django-rest-tsg 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
django-rest-tsg 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 MIT
开发语言 Python
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
投 递 者 亦念
适用人群 未知
收录时间 2021-12-17

软件简介

django-rest-tsg 是一个用于 Django REST Framework 的 TypeScript 代码生成器。

支持从以下 Python 类型生成相应的 TypeScript 代码。

  • Django REST Framework 的序列化类:手工编写的序列化类(Serializer)、模型生成的序列化类(ModelSerializer)、数据类生成的序列化类(DataclassSerializer)
  • Python 的数据类:dataclasses.dataclass 修饰的类
  • Python 的枚举类:enum.Enum 的子类

并且支持上述类型的复合、嵌套类型的依赖处理。

安装

可直接从 PyPI 下载安装

$ pip install django_rest_tsg

使用

在 Django 项目的根目录中添加名为 tsgconfig.py 的配置文件。通过 BUILD_DIR 设置生成 TypeScript 代码文件的目录。在 BUILD_TASKS 列表中用 build 函数设置生成任务,参数分别为生成任务的源类型、生成目录和其他配置。

from django.conf import settings
from django_rest_tsg.build import build

BUILD_DIR = settings.BASE_DIR / 'app/src/core'

BUILD_TASKS = [
    build(Foo),
    build(BarSerializer, 'app/src/app/core', {'alias': 'Foobar'}),
]

django_rest_tsg 添加到 Django 配置文件中的 INSTALLED_APPS 列表中。

INSTALLED_APPS = [
    ...
    'django_rest_tsg'
]

运行 manage.py 上的 buildtypescript 命令即可向预定目录生成相应的 TypeScript 代码。

$ python manage.py buildtypescript
展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论

点击引领话题📣
暂无内容
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
0 评论
1 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部
返回顶部
顶部