建立第一个RESTful api server(实作篇)-2(Day14)

在上一步我们建立了一个基础的echo的server
紧接着我们就要建立第一个crud的api了

关於我们未来会需要几个资料表
request(储存需要触发的IOT物件)
command(使用者需要触发的事件)
而这个系统最基础的需求是

使用者可以透过命令的触发，来依序执行request的事件
而每个request可以被多个命令重复利用

所以因为这些需求，会需要开设这些表
table: request
columns:

• uuid(uuid)
• create_at(timestamptz)
• update_at(timestamptz)
• name(varchar)

table: command
columns:

• uuid(uuid)
• create_at(timestamptz)
• update_at(timestamptz)
• url(varchar)

table:request_command
columns:

• uuid(uuid)
• create_at(timestamptz)
• update_at(timestamptz)
• request_uuid(uuid)
• command_uuid(uuid)
• order(int)

而在我们的流程中，要先有command跟request才可以建立其中的连结，因此需要先建立commands/requests的api

需要完成的API规格如下
https://www.postman.com/collections/c00ca09e40a2769fd96e

在属性命名上，属性名称主要是camel case，首字为小写

另外，在api的规范上，参考JSend
https://github.com/omniti-labs/jsend

规范如下

• 成功
  • 定义
    要求被成功执行
  • 资料格式如下

{
    "status": "success",
    "data": {
        // 回传的资料内容
    }
}

• 失败
  • 定义
    资料被正常执行完，发现其中资料有被程序检查出来的问题时
  • 资料格式如下

{
    "status": "fail",
    "data": {
        // 资料格式不对的回传内容
    }
}

• 错误
  • 定义
    资料并没有被正确的处理，而回传的错误
  • 资料格式如下

{
    "status": "error",
    "message": "错误讯息"
}