跳转到内容

官方模板

Restorm 维护一套 官方模板,您可以直接从模板库 使用它们。您也可以从其中之一出发,把它 fork 并按您的约定进行调整。

模板库:官方、最近使用和自定义的模板

官方模板发布在 GitHub 组织 Monsieur-Dev 之下:

模板目标仓库
REST 服务器 · TypeScriptREST · TypeScript · Expressrestorm-template-server-rest-typescript
REST 服务器 · .NETREST · C# · ASP.NET Corerestorm-template-server-rest-dotnet
gRPC 服务器 · TypeScriptgRPC · TypeScriptrestorm-template-server-grpc-typescript
gRPC 服务器 · .NETgRPC · C# / .NETrestorm-template-server-grpc-dotnet
PostgreSQL 数据库SQL · PostgreSQLrestorm-template-db-postgres

远程模板会作为一个 归档 获取(从不用 git 克隆),并带有安全防护栏和封顶的 大小。

使用 Enterprise 订阅的组织拥有一个 私有 的模板目录,在组织成员之间共享。 它们出现在库中的 Templates <组织> 标签页里,与官方模板并列。

  • 谁可以添加或移除:组织的一个 管理员,或一个被管理员授予 管理模板 权限的成员。
  • 如何操作:从库的 Templates <组织> 标签页(添加 按钮 —— 仓库 URL 和一段描述),或从组织的 管理仪表板。
  • 它是什么:一个组织模板只是一个 指向 git 仓库的指针(就像官方模板一样); 它的结构与下面描述的相同,但其可见性被限制在组织成员范围内。

Community 和 Pro 版本能看到官方模板,并可以使用它们自己的模板(仓库 或 本地文件夹)—— 代码生成在所有版本中都是免费的。而共享的 组织 模板 则专属于 Enterprise 版本。

一个 Restorm 模板是一个用清单增强过的 Cookiecutter/Copier 模板:

  • restorm-template.json —— 位于仓库的 根目录(必需)。它描述模板,并声明 它所消费的 变量(参见生成变量)。它还宣告它所 支持的 上下文版本:一个不声明与应用程序兼容版本的模板会被拒绝。
  • copier.yml(或 copier.yaml)—— Copier 配置,其中尤其声明了生成时提出的 问题。
  • 模板的文件,以 .jinja 为后缀,用设计的上下文渲染。

要使用一个自定义模板,请在库中选择来源 仓库(GitHub 上的 owner/name)或 本地文件夹(在您开发它期间)。