客户端代码工具使用说明.md
4.7 KB
1. 客户端工具下载
1.1 版本 v0.1.0
2. 账号登录
账号需要向平台服务申请,用户名为 申请人手机号 默认密码 mmm123456
3. 项目初始化
设置项目/描述文件路径
4. 应用描述文件生成
4.1 添加属性描述 (attribute)
属性是描述文件的最小单元
attibute名称
例如此处 taskId
属性名称会影响到描述文件的文件名称,这边会生成的描述文件
taskId.yaml
attribute类型 包含
primitive: 原始类型,包括:string,boolean,int,int32,int64,uint,uint32,uint64,float32,float64,datetime,bytes
array: 原始类型数组,或者自定义模式数组,例子:string或者task
schema: 自定义模式,Schema描述的name字段,例子:task
attribute 所在文件名称
例如此处 task
生成的描述文件就会保存在 /task/taskId.yaml
文件内容如下
version: v1
kind: Attribute
metadata:
name: taskId
description: 任务编号
type:
primitive: int64
4.2 添加结构描述(schema)
生成描述文件 /schemas/task.yaml
version: v1
kind: Schema
metadata:
name: task
description: 任务实体
attributes:
- ref: taskId
required: true
- ref: taskName
required: true
- name: taskDescription
description: 任务描述-(这边写入自定义属性的描述)
type:
primitive: string
4.3 添加服务描述 (service)
method名称 :指定CURD 工具会自动生成服务方法 create、get、list、remove、update
F:\eggcode\dsl\godevp\services\task\methods\createTask.yaml
F:\eggcode\dsl\godevp\services\task\methods\getTask.yaml
F:\eggcode\dsl\godevp\services\task\methods\listTask.yaml
F:\eggcode\dsl\godevp\services\task\methods\removeTask.yaml
F:\eggcode\dsl\godevp\services\task\methods\updateTask.yaml
F:\eggcode\dsl\godevp\services\task\service.yaml
4.4 添加接口描述(api)
生成描述文件 /http/task.yaml
version: v1
kind: HttpApi
metadata:
service: task
path: /tasks
endpoints:
- method: createTask
route:
post: /
- method: updateTask
route:
put: /{taskId} ##注意这边需要手动加上task
- method: getTask
route:
get: /{taskId} ##注意这边需要手动加上task
- method: removeTask
route:
delete: /{taskId} ##注意这边需要手动加上task
- method: listTask
route:
get: /
params:
- name: offset
- name: limit
5. 生成项目代码
5.1 生成项目脚手架 (基础文件)
指定web框架、数据库