djago-rest-tsg是一个用于DjagoRESTFramework的TypeScript代码生成器。
支持从以下Pytho类型生成相应的TypeScript代码。
DjagoRESTFramework的序列化类:手工编写的序列化类(Serializer)、模型生成的序列化类(ModelSerializer)、数据类生成的序列化类(DataclassSerializer)Pytho的数据类:dataclasses.dataclass修饰的类Pytho的枚举类:eum.Eum的子类并且支持上述类型的复合、嵌套类型的依赖处理。
安装
可直接从PyPI下载安装
$pipistalldjago_rest_tsg使用
在Djago项目的根目录中添加名为tsgcofig.py的配置文件。通过BUILD_DIR设置生成TypeScript代码文件的目录。在BUILD_TASKS列表中用build函数设置生成任务,参数分别为生成任务的源类型、生成目录和其他配置。
fromdjago.cofimportsettigsfromdjago_rest_tsg.buildimportbuildBUILD_DIR=settigs.BASE_DIR/'app/src/core'BUILD_TASKS=[build(Foo),build(BarSerializer,'app/src/app/core',{'alias':'Foobar'}),]把djago_rest_tsg添加到Djago配置文件中的INSTALLED_APPS列表中。
INSTALLED_APPS=[...'djago_rest_tsg']运行maage.py上的buildtypescript命令即可向预定目录生成相应的TypeScript代码。
$pythomaage.pybuildtypescript









评论