目描述規(guī)范完整指南：一次搞懂項(xiàng)目、App、模型與關(guān)系的全部配置)
Django Builder JSON項(xiàng)目描述規(guī)范完整指南一次搞懂項(xiàng)目、App、模型與關(guān)系的全部配置【免費(fèi)下載鏈接】django_builderDjango Builder Site項(xiàng)目地址: https://gitcode.com/gh_mirrors/dj/django_builderDjango Builder 是一款用 JSON 文件描述即可生成完整 Django 項(xiàng)目的開源工具。這篇文章作為 Django Builder JSON 項(xiàng)目描述規(guī)范的參考帶你一次搞懂項(xiàng)目Project、App、模型Model與關(guān)系Relationship的全部配置從 4 個(gè)配置層級(jí)到每個(gè)字段選項(xiàng)再到一條命令打包出可運(yùn)行的項(xiàng)目 Django Builder 編輯器上方可視化配置 App 與模型下方即時(shí)生成 models.py、views.py、forms.py一、JSON 規(guī)范的 4 層結(jié)構(gòu)整個(gè)規(guī)范非常清晰只有 4 層嵌套層級(jí)JSON 鍵對(duì)應(yīng) Django 概念① 項(xiàng)目name/description/htmx/postgressettings.py、requirements.txt② 應(yīng)用apps數(shù)組中的每一項(xiàng)一個(gè) Django App如app1③ 模型App 下models數(shù)組中的每一項(xiàng)models.py 中的一個(gè) Model 類④ 字段與關(guān)系模型下的fields和relationships具體字段、外鍵等完整的數(shù)據(jù)結(jié)構(gòu)定義可參考類型聲明文件 types.ts 和核心實(shí)現(xiàn) api.ts。二、第一層項(xiàng)目級(jí)配置項(xiàng)目層位于 JSON 根節(jié)點(diǎn)控制生成什么樣的項(xiàng)目配置項(xiàng)類型說明name字符串項(xiàng)目名將作為目錄名description字符串項(xiàng)目描述會(huì)寫入生成的代碼注釋version數(shù)字Django 版本2 / 3 / 4缺省為 4htmx布爾是否啟用 HTMX 模板自動(dòng)生成django_htmx中間件postgres布爾是否使用 PostgreSQL 數(shù)據(jù)庫(kù)channels布爾是否啟用 Django ChannelsWebSocket 支持pillow布爾是否安裝 Pillow圖片處理依賴一個(gè)最簡(jiǎn)項(xiàng)目只有一項(xiàng)配置即可運(yùn)行倉(cāng)庫(kù)提供了兩個(gè)現(xiàn)成樣例基礎(chǔ)版example-project.jsonPostgreSQL 版example-project-postgres.json三、第二層App 與模型apps是一個(gè)數(shù)組每個(gè) App 對(duì)應(yīng)生成項(xiàng)目里的一個(gè)應(yīng)用目錄{ name: DjangoProject, description: A Django Project with great potential, htmx: false, postgres: false, apps: [ { name: DjangoApp1, models: [ /* 模型定義放這里 */ ] } ] }每個(gè) App 下的models數(shù)組就是數(shù)據(jù)庫(kù)模型的圖紙。每個(gè)模型除了name還包含兩個(gè)核心數(shù)組fields—— 普通數(shù)據(jù)字段relationships—— 外鍵等關(guān)系字段四、第三層字段fields怎么配添加字段Name Field Type args 三要素與 models.py 中的寫法一一對(duì)應(yīng)每個(gè)字段由 3 個(gè)屬性組成屬性示例說明namefield1字段名即 Python 屬性名typeCharField字段類型取 Django 字段類的短名argsmax_length30完整參數(shù)串原樣拼進(jìn)生成的代碼常用字段類型完整清單見 api.tsCharField·TextField·BooleanField·IntegerField·DecimalField·DateField·DateTimeField·EmailField·URLField·SlugField·UUIDField·JSONField·ImageField…當(dāng)項(xiàng)目啟用postgres: true時(shí)還可以使用 PostgreSQL 專屬類型ArrayField、HStoreField、CICharField、DateTimeRangeField等區(qū)間字段范圍類字段會(huì)標(biāo)記is_postgres_range。小技巧args里寫editableFalse的字段會(huì)被識(shí)別為只讀字段不會(huì)出現(xiàn)在生成的表單里——樣例文件中的created/last_updated時(shí)間戳字段就是這么實(shí)現(xiàn)的。五、第三層關(guān)系relationships怎么配添加關(guān)系支持 ForeignKey、OneToOneField、ManyToManyField 三種類型關(guān)系配置在結(jié)構(gòu)上與字段類似多了一個(gè)to指明指向誰屬性示例說明namerelationship1關(guān)系屬性名typeForeignKey僅支持 3 種ForeignKey/OneToOneField/ManyToManyFieldtoauth.User目標(biāo)模型應(yīng)用名.模型名格式argsnullTrue,on_deletemodels.CASCADE關(guān)系參數(shù)to目前支持指向 Django 內(nèi)置模型內(nèi)置模型清單定義在 api.ts 的BuiltInModelTypes中auth.User/auth.AbstractUser/auth.AbstractBaseUser/auth.Group?? 注意to引用的必須是內(nèi)置模型或已定義模型否則渲染時(shí)會(huì)拋出Unsupported relationship to ...錯(cuò)誤——這是新手最常踩的坑。六、一條命令JSON → 可運(yùn)行項(xiàng)目配置完成后用 CLI 的render命令即可打包出完整項(xiàng)目。解析邏輯在 cli.ts 中實(shí)現(xiàn)./bin/django-builder example_projects/example-project.json DjangoProject.tar tar -xvf DjangoProject.tar cd DjangoProject pip install -r requirements.txt python manage.py migrate python manage.py runserver生成的項(xiàng)目包含完整的 views、forms、urls、admin、序列化器、REST API 和 pytest 測(cè)試同一份 JSON 描述自動(dòng)渲染出的 API 路由、序列化器、管理后臺(tái)與測(cè)試文件生成的 Python 代碼由模板渲染核心模板位于 models.ts模板機(jī)制實(shí)現(xiàn)在 rendering.ts。七、進(jìn)階把現(xiàn)有 models.py 導(dǎo)入規(guī)范如果你已有寫好的 Django 模型ModelImporter可以解析models.py源碼并還原成規(guī)范的模型結(jié)構(gòu)識(shí)別字段類型、外鍵關(guān)系、Meta.abstract等實(shí)現(xiàn)在 importer.ts —— 也就是說這套 JSON 規(guī)范既能由 JSON 生成代碼也能作為代碼到結(jié)構(gòu)的中間表示。八、常見問題速查Q1字段類型寫錯(cuò)會(huì)怎樣渲染時(shí)直接報(bào)錯(cuò)Unsupported field type XXX請(qǐng)對(duì)照FieldTypes清單檢查拼寫短名即可如CharField而非django.db.models.CharField。Q2args里參數(shù)之間怎么分隔用英文逗號(hào)分隔如nullTrue,on_deletemodels.CASCADE它會(huì)原樣嵌入生成的models.py語法即 Django 標(biāo)準(zhǔn)寫法。Q3為什么生成的是 tar 包而不是目錄Renderer.tarballContent()先打包再輸出解壓后即可運(yùn)行天然適合 CI 與模板分發(fā)場(chǎng)景?？偨Y(jié)Django Builder 的 JSON 規(guī)范本質(zhì)是一張項(xiàng)目藍(lán)圖項(xiàng)目層聲明技術(shù)選型Django 版本、HTMX、PostgreSQL、ChannelsApp 層劃分應(yīng)用邊界模型層用fieldsrelationships兩張表描述數(shù)據(jù)結(jié)構(gòu)一條render命令藍(lán)圖變成可運(yùn)行的完整 Django 工程。掌握這 4 層結(jié)構(gòu)后無論是手工編寫還是程序化生成配置你都能快速駕馭這個(gè)聲明式 Django 腳手架?！久赓M(fèi)下載鏈接】django_builderDjango Builder Site項(xiàng)目地址: https://gitcode.com/gh_mirrors/dj/django_builder創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考 Django Builder JSON項(xiàng)目描述規(guī)范完整指南：一次搞懂項(xiàng)目、App、模型與關(guān)系的全部配置
Django Builder JSON項(xiàng)目描述規(guī)范完整指南一次搞懂項(xiàng)目、App、模型與關(guān)系的全部配置【免費(fèi)下載鏈接】django_builderDjango Builder Site項(xiàng)目地址: https://gitcode.com/gh_mirrors/dj/django_builderDjango Builder 是一款用 JSON 文件描述即可生成完整 Django 項(xiàng)目的開源工具。這篇文章作為 Django Builder JSON 項(xiàng)目描述規(guī)范的參考帶你一次搞懂項(xiàng)目Project、App、模型Model與關(guān)系Relationship的全部配置從 4 個(gè)配置層級(jí)到每個(gè)字段選項(xiàng)再到一條命令打包出可運(yùn)行的項(xiàng)目 Django Builder 編輯器上方可視化配置 App 與模型下方即時(shí)生成 models.py、views.py、forms.py一、JSON 規(guī)范的 4 層結(jié)構(gòu)整個(gè)規(guī)范非常清晰只有 4 層嵌套層級(jí)JSON 鍵對(duì)應(yīng) Django 概念① 項(xiàng)目name/description/htmx/postgressettings.py、requirements.txt② 應(yīng)用apps數(shù)組中的每一項(xiàng)一個(gè) Django App如app1③ 模型App 下models數(shù)組中的每一項(xiàng)models.py 中的一個(gè) Model 類④ 字段與關(guān)系模型下的fields和relationships具體字段、外鍵等完整的數(shù)據(jù)結(jié)構(gòu)定義可參考類型聲明文件 types.ts 和核心實(shí)現(xiàn) api.ts。二、第一層項(xiàng)目級(jí)配置項(xiàng)目層位于 JSON 根節(jié)點(diǎn)控制生成什么樣的項(xiàng)目配置項(xiàng)類型說明name字符串項(xiàng)目名將作為目錄名description字符串項(xiàng)目描述會(huì)寫入生成的代碼注釋version數(shù)字Django 版本2 / 3 / 4缺省為 4htmx布爾是否啟用 HTMX 模板自動(dòng)生成django_htmx中間件postgres布爾是否使用 PostgreSQL 數(shù)據(jù)庫(kù)channels布爾是否啟用 Django ChannelsWebSocket 支持pillow布爾是否安裝 Pillow圖片處理依賴一個(gè)最簡(jiǎn)項(xiàng)目只有一項(xiàng)配置即可運(yùn)行倉(cāng)庫(kù)提供了兩個(gè)現(xiàn)成樣例基礎(chǔ)版example-project.jsonPostgreSQL 版example-project-postgres.json三、第二層App 與模型apps是一個(gè)數(shù)組每個(gè) App 對(duì)應(yīng)生成項(xiàng)目里的一個(gè)應(yīng)用目錄{ name: DjangoProject, description: A Django Project with great potential, htmx: false, postgres: false, apps: [ { name: DjangoApp1, models: [ /* 模型定義放這里 */ ] } ] }每個(gè) App 下的models數(shù)組就是數(shù)據(jù)庫(kù)模型的圖紙。每個(gè)模型除了name還包含兩個(gè)核心數(shù)組fields—— 普通數(shù)據(jù)字段relationships—— 外鍵等關(guān)系字段四、第三層字段fields怎么配添加字段Name Field Type args 三要素與 models.py 中的寫法一一對(duì)應(yīng)每個(gè)字段由 3 個(gè)屬性組成屬性示例說明namefield1字段名即 Python 屬性名typeCharField字段類型取 Django 字段類的短名argsmax_length30完整參數(shù)串原樣拼進(jìn)生成的代碼常用字段類型完整清單見 api.tsCharField·TextField·BooleanField·IntegerField·DecimalField·DateField·DateTimeField·EmailField·URLField·SlugField·UUIDField·JSONField·ImageField…當(dāng)項(xiàng)目啟用postgres: true時(shí)還可以使用 PostgreSQL 專屬類型ArrayField、HStoreField、CICharField、DateTimeRangeField等區(qū)間字段范圍類字段會(huì)標(biāo)記is_postgres_range。小技巧args里寫editableFalse的字段會(huì)被識(shí)別為只讀字段不會(huì)出現(xiàn)在生成的表單里——樣例文件中的created/last_updated時(shí)間戳字段就是這么實(shí)現(xiàn)的。五、第三層關(guān)系relationships怎么配添加關(guān)系支持 ForeignKey、OneToOneField、ManyToManyField 三種類型關(guān)系配置在結(jié)構(gòu)上與字段類似多了一個(gè)to指明指向誰屬性示例說明namerelationship1關(guān)系屬性名typeForeignKey僅支持 3 種ForeignKey/OneToOneField/ManyToManyFieldtoauth.User目標(biāo)模型應(yīng)用名.模型名格式argsnullTrue,on_deletemodels.CASCADE關(guān)系參數(shù)to目前支持指向 Django 內(nèi)置模型內(nèi)置模型清單定義在 api.ts 的BuiltInModelTypes中auth.User/auth.AbstractUser/auth.AbstractBaseUser/auth.Group?? 注意to引用的必須是內(nèi)置模型或已定義模型否則渲染時(shí)會(huì)拋出Unsupported relationship to ...錯(cuò)誤——這是新手最常踩的坑。六、一條命令JSON → 可運(yùn)行項(xiàng)目配置完成后用 CLI 的render命令即可打包出完整項(xiàng)目。解析邏輯在 cli.ts 中實(shí)現(xiàn)./bin/django-builder example_projects/example-project.json DjangoProject.tar tar -xvf DjangoProject.tar cd DjangoProject pip install -r requirements.txt python manage.py migrate python manage.py runserver生成的項(xiàng)目包含完整的 views、forms、urls、admin、序列化器、REST API 和 pytest 測(cè)試同一份 JSON 描述自動(dòng)渲染出的 API 路由、序列化器、管理后臺(tái)與測(cè)試文件生成的 Python 代碼由模板渲染核心模板位于 models.ts模板機(jī)制實(shí)現(xiàn)在 rendering.ts。七、進(jìn)階把現(xiàn)有 models.py 導(dǎo)入規(guī)范如果你已有寫好的 Django 模型ModelImporter可以解析models.py源碼并還原成規(guī)范的模型結(jié)構(gòu)識(shí)別字段類型、外鍵關(guān)系、Meta.abstract等實(shí)現(xiàn)在 importer.ts —— 也就是說這套 JSON 規(guī)范既能由 JSON 生成代碼也能作為代碼到結(jié)構(gòu)的中間表示。八、常見問題速查Q1字段類型寫錯(cuò)會(huì)怎樣渲染時(shí)直接報(bào)錯(cuò)Unsupported field type XXX請(qǐng)對(duì)照FieldTypes清單檢查拼寫短名即可如CharField而非django.db.models.CharField。Q2args里參數(shù)之間怎么分隔用英文逗號(hào)分隔如nullTrue,on_deletemodels.CASCADE它會(huì)原樣嵌入生成的models.py語法即 Django 標(biāo)準(zhǔn)寫法。Q3為什么生成的是 tar 包而不是目錄Renderer.tarballContent()先打包再輸出解壓后即可運(yùn)行天然適合 CI 與模板分發(fā)場(chǎng)景?？偨Y(jié)Django Builder 的 JSON 規(guī)范本質(zhì)是一張項(xiàng)目藍(lán)圖項(xiàng)目層聲明技術(shù)選型Django 版本、HTMX、PostgreSQL、ChannelsApp 層劃分應(yīng)用邊界模型層用fieldsrelationships兩張表描述數(shù)據(jù)結(jié)構(gòu)一條render命令藍(lán)圖變成可運(yùn)行的完整 Django 工程。掌握這 4 層結(jié)構(gòu)后無論是手工編寫還是程序化生成配置你都能快速駕馭這個(gè)聲明式 Django 腳手架?！久赓M(fèi)下載鏈接】django_builderDjango Builder Site項(xiàng)目地址: https://gitcode.com/gh_mirrors/dj/django_builder創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考