Restful 风格的 api 虽然规范了四个方法(Get
、Post
、Put
、Delete
)用于数据的查询、增加、修改和删除,但在实际应用中,还是会有很多公司只使用了 Get
和 Post
两个方法,查询数据使用 Get
方法,其它业务操作使用 Post
方法(为什么会有情况,以后可以写一篇文章讨论一下 _),但是 Post
方法一般通过 FromBody
标识进行传参,这样子有时候会显得 api 不太优雅,比如删除一条数据,通常会将要删除的数据的 ID 写在 URL 上,比如:
.../api/delete/1000
1000 就是要删除的数据的 ID,但是按正常的 Post 的写法则是:
.../api/delete
然后前端在参数部分单独写上要删除的数据的 ID,比如 {"id": 1000}
,这样就显得不够清晰明了。
如果使用 FromUri
标识传参,又会将 URL 变得很长,如:
.../api/delete?id=1000
那么,难道 Post 方法不能把参数加到 URL 中吗?
答案当然是否定的,因为这四个方法本质上是一样的,那么,要怎么写才能让 Post 方法把参数加到 URL 中呢?
其实很简单,像下面这么写就可以了 😃 :
- 在路由中使用
{xxx}
符号指定 URL 格式 - Post 方法中的参数采用普通方法的参数的形式即可
{xxx}
符号里 xxx 跟 Post 方法中的参数一致
代码示例:
[HttpPost] [Route("api/delete/{itemGuid}")] public IHttpActionResult Delete(string itemGuid) { _customerInfoService.Value.DeleteCustomer(itemGuid); return Ok(Success()); // NoContent(); }
这样,就可以使用 Post api/delete/1000
来删除数据了,api 是不是就显得很优雅呢?