RESTFUL 风格API

去年刚入职这家公司的时候要求用restful,微服务。

给整的一脸懵逼。最后发现restful一点也不神奇。

特此 记录一下精华,给需要的小伙伴。

     精华 1 ,http的请求方式 表示动作 !http的请求方式 表示动作 !!http的请求方式 表示动作 !!!

               常用的四种  get,post,put,delete

               得到数据就用get,新增数据就用post,修改就用put,删除就用delete

              2 地址中不要有动词!地址中不要有动词!!地址中不要有动词!!!

                 http的请求方式已经表明想要做什么,所以不需要在地址用加动词。

示例错误的 api

       get      /api/v1.0/getUser

       post      /api/v1.0/saveUser

      post      /api/v1.0/updateUser

      post     /api/v1.0/deleteUser

正确的resutful风格的接口

     get         /api/v1.0/user

    post        /api/v1.0/user

    put         /api/v1.0/user

   delete      /api/v1.0/user

自认比较规范的后台接口示意

  

上面的controller生成的swagger 如下

 

完毕,qq 102528071   小伙伴们可以交流一下。

设计 RESTful 风格 API 的 URL,通常需要考虑以下几个方面: 1. 遵循 URL 的命名规范:URL 命名应该简洁易懂,采用小写字母和短划线进行分隔。 2. 使用名词表示资源:RESTful API 设计中的 URL 应该是名词,而不是动词。例如,使用 `/users` 表示用户资源,而不是 `/get_users`。 3. 使用 HTTP 动词表示操作:RESTful API 设计中的 HTTP 方法应该表示所要执行的操作。例如,使用 HTTP GET 方法获取资源,使用 POST 方法创建资源,使用 PUT 方法更新资源,使用 DELETE 方法删除资源。 4. 使用路径参数和查询参数:使用路径参数表示资源的唯一标识符,使用查询参数表示对资源的筛选和排序操作。 下面以一个简单的例子说明如何设计 RESTful 风格 API 的 URL: 假设我们要设计一个博客网站的 API,其中包含文章和评论两个资源。文章可以被创建、查看、更新和删除,评论可以被创建和查看。 文章资源的 URL 设计如下: - 获取所有文章:`GET /articles` - 获取指定 ID 的文章:`GET /articles/:id` - 创建文章:`POST /articles` - 更新指定 ID 的文章:`PUT /articles/:id` - 删除指定 ID 的文章:`DELETE /articles/:id` 评论资源的 URL 设计如下: - 获取指定文章的所有评论:`GET /articles/:article_id/comments` - 创建评论:`POST /articles/:article_id/comments` - 获取指定 ID 的评论:`GET /articles/:article_id/comments/:id` 在上述例子中,使用了路径参数和查询参数来表示资源的唯一标识符和对资源的操作。同时,HTTP 方法也清晰地表示了对资源的操作类型。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值