API 设计器

API 设计器 让您直接在 Restorm 中设计一个完整的 API：您描述数据和路由， 其余的交给 Restorm —— 它把您的设计像一个真正的 mock 服务器一样 提供服务， 并根据模板 生成 您的应用程序代码。

在后端尚不存在时启动一个 API，这是理想的工具：把契约做成原型，让您的客户端 测试它，并把一切以受版本控制的方式保存在您的项目中。

一个设计，多个部分

设计像任何其他元素一样创建：右键点击文件夹 ▸ 添加 ▸ API 设计。它在自己的 标签页中打开，并汇集了可从侧边栏访问的多个部分：

部分	用途
模型	您的实体及其属性 —— 参见模型、枚举和属性。
枚举	封闭的值集合，可作为属性类型复用。
路由	API 的入口点，按资源分组 —— 参见路由与 CRUD。
服务器	以 HTTP、GraphQL、SOAP、OData 或 gRPC 将设计作为 mock 提供服务 —— 参见将设计作为 mock 提供服务。
客户端	调用运行中 mock 的即用型请求 —— 参见客户端。
文档 与 备注	附加到设计上的自由文档与备注。
代码	根据您的模板生成代码 —— 参见代码生成。

设计的 设置（名称、默认值）通过直接点击侧边栏中的设计节点打开。

典型流程

1. 描述您的数据 —— 创建模型和枚举，添加它们的属性、类型和约束。
2. 定义您的路由 —— 手动定义，或者从模型一键 生成 CRUD。
3. 提供 mock 服务 —— 启动服务器并把您的应用程序或客户端指向它。同一个设计 会自动投影到每个已启用的协议中。
4. 生成代码 —— 选择一个或多个模板（您自己的，或 Restorm 提供的）并生成 相应的项目。

每个步骤都在本部分的各页面中详细说明。