官术网_书友最值得收藏!

Naming for RPC

With RPC you do not have the luxury of using HTTP verbs to confer the intent of the API, for example, you have the collection users. With an HTTP API you would be able to split up the various actions using GET, POST, DELETE, and so on. This is not possible with an RPC API and you need to think in the same way as if you were writing methods inside your Go code, so for example:

GET /v1/users 

The preceding code might be written as an RPC method as follows:

Users.v1.Users 
GET /v1/users/123434

Alternatively, it might be written as an RPC method as follows:

Users.v1.User 

Sub collections become a little less semantic, whereas in a RESTful API you would be able to do the following:

GET /v1/users/12343/permissions/1232 

You cannot do this with an RPC API and you must explicitly specify the method as a separate entity:

Permissions.v1.Permission 

The method name also needs to infer the action that the API is going to perform; you cannot rely on the use of HTTP verbs, so in the instance that you have a method that can delete a user you would have to add the delete verb into the method call, for example:

DELETE /v1/users/123123 

The preceding code would become:

Users.v1.DeleteUser 
主站蜘蛛池模板: 泉州市| 桑日县| 平原县| 巴里| 青神县| 清徐县| 台湾省| 小金县| 安福县| 松原市| 获嘉县| 张家口市| 保山市| 鹤庆县| 广州市| 南澳县| 皮山县| 高邮市| 淳化县| 卓资县| 美姑县| 安徽省| 曲阜市| 布尔津县| 葫芦岛市| 济源市| 比如县| 罗城| 兴城市| 濉溪县| 宁津县| 庐江县| 长岛县| 兖州市| 淮北市| 扶余县| 东港市| 永吉县| 镇宁| 离岛区| 遂川县|