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

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 
主站蜘蛛池模板: 集安市| 曲沃县| 资中县| 阿鲁科尔沁旗| 浦北县| 南安市| 濉溪县| 东辽县| 苍梧县| 永嘉县| 库车县| 公安县| 西吉县| 西林县| 乐都县| 定陶县| 健康| 邵武市| 德阳市| 舟山市| 峨眉山市| 永宁县| 馆陶县| 余姚市| 宁蒗| 剑河县| 平利县| 双江| 汝城县| 来安县| 额尔古纳市| 伊通| 乌拉特后旗| 出国| 福泉市| 仁怀市| 宁乡县| 汉沽区| 蓬安县| 息烽县| 清原|