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

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 
主站蜘蛛池模板: 离岛区| 阜阳市| 阿克陶县| 安阳县| 长顺县| 密山市| 绥棱县| 宁武县| 泰兴市| 莆田市| 宁城县| 集安市| 神木县| 正宁县| 湖北省| 沙湾县| 西和县| 博爱县| 怀安县| 和平区| 文昌市| 东明县| 临沂市| 定兴县| 板桥市| 剑河县| 宣城市| 海晏县| 常熟市| 汕尾市| 乌鲁木齐市| 浮梁县| 鹤山市| 楚雄市| 宜兰县| 玛曲县| 邢台县| 太康县| 张家界市| 磴口县| 三门县|