API路径命名约定

寻找API创建者的建议...API路径命名约定

我有一个简单的应用程序，它调用Google日历API。我只有一个模型类型，'用户'。我不会存储任何日历信息，只需使用其访问令牌代表用户拨打日历API即可。

我已经定义了以下路线：

POST /user：创建一个用户对象

GET /user：检索用户

PATCH /user/:id：更新用户信息

我想现在做一个路线获取用户的日历。如上所述，这只是使用用户的访问令牌并调用日历API，该API返回日历项目数组。命名此路线的正确方法是什么？

我在想......

GET /calendars或/calendar - 但我不认为这是正确的，因为我实际上并不在我的应用程序

GET /user/:id/calendar一个“日历”的模式？

这是什么标准？

来源

2014-11-02 Alex

首先，你需要多使用资源名称：

POST /users

怎么样GET /users/:id/events？

所以，你可以使用

POST /events

创建事件等等。

日历只是一种表示。日历是一组事件。

公约，相对于单数和复数的名字：

控制器名称： UsersController

型号名称：用户

来源

2014-11-02 00:09:09 fntneves

权，但由于谷歌API调用返回的日历列表（与事件无关），在路线名称中有事件，我不认为是明确的。我从来没有创建日历，只能得到它们的列表。我确实基于选定的calendar_id创建了日历活动，但这将发生在不同的路线中。 – Alex 2014-11-02 00:14:18

你有什么模特？您可以添加此通话返回的回复，首先发布？ – fntneves 2014-11-02 00:15:51

我唯一的模型是'用户'，它现在具有诸如'姓名，电子邮件，access_token，refresh_token，照片'等属性。通过添加此调用返回的响应，不理解您的意思。我将响应（日历列表）作为JSON返回，并且我的Angular控制器在其上运行ng-repeat – Alex 2014-11-02 00:17:44

API路径命名约定

回答

相关问题