宁静的api自定义类型

时间:2014-02-03 21:26:25

标签: api rest

所以我正在构建一个允许用户发送事件的restful api。

有生日,婚礼等“标准”事件,每个事件都有各自的属性。因此,如果有人发送type = birthday的数据,他们也可以指定参数date_of_birthday,new_age等。例如,如果他们发送type = wedding,他们必须指定不同的属性。

所以基本上当他们进行/ event / create api调用时,他们会根据该类型指定一个类型和一个属性列表。如果他们想要指定“自定义”类型,他们可以。在这种情况下,他们指定的属性取决于它们。

如何最好地构建这个api以便它可以休息?

2 个答案:

答案 0 :(得分:0)

要创建活动,客户应该发出类似

的POST请求

HTTP POST:/ event

post参数应包含事件详细信息,并且可以是应用程序理解的任何结构。

答案 1 :(得分:0)

使用POST创建事件,此请求本身代表“创建新事件”。我还建议您使用以下API URI结构:

POST /event/birthday             //Create new birthday event
POST /event/wedding              //Create new wedding event
...

通常:

POST /event/{event_name}

这将帮助您提供RESTful API的清晰结构。例如。可以使用GET /event检索所有事件类型,使用GET /event/birthday获取所有生日,在2014年1月1日举行婚礼GET /event/wedding/1-1-2014

以相同的方式考虑您的资源URI结构,您将定义文件夹和文件结构。