java - 设计用于函数调用的 REST api

Question

因此，我正在构建一个 REST APi，它将负责在特殊硬件上运行各种作业。

所以我理解REST是用于访问资源而不是调用函数。
那么设计负责调用函数的 API 的建议和最佳方法是什么。

例如，我将有一个 api job/run，如果作业成功运行，它将返回作业的 PID。我还将有一个 job/{pid} 用于访问有关给定作业的信息。和 job/cancel/{pid} 用于停止所述作业。

Answer 1

So what are the recommendations and best way to design an API for responsible for calling functions

1. 创建用户:POST/users
2. 删除用户:DELETE/users/1
3. 获取所有用户:GET/users
4. 获取一名用户:GET/users/1

To GET Record

糟糕的设计

GET /FetchUsers                  // To fetch all records
GET /getAllUsers/12              // To fetch specific records

首选设计

GET /users                      //To fetch all records
GET /users/12                   // To fetch specific records

To Crete Record

糟糕的设计

POST /createUsers                //To create users
GET  /createrecordforUsers      //To fetch all records

首选设计

POST /users                     //To create users records

To Update Record

糟糕的设计

PUT  /updateUsersid               // To update user
POST /id/modifyuser              // To update users

首选设计

PUT /users/:id                     // To update users

To Delete Record

糟糕的设计

DELETE /deleteuser/id              //To delete users
POST   /id/removeusers            //To delete users

首选设计

DELETE /users/:id               // To delete users