Restful API设计规范学习笔记

最新推荐文章于 2023-07-11 18:36:06 发布
最新推荐文章于 2023-07-11 18:36:06 发布
阅读量269 收藏
点赞数
分类专栏： Restful API设计规范 文章标签： restful api设计规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_15941409/article/details/83826888
版权

1 api专有域名/或在项目中建立API专用目录

2 URL中加入版本号 v1,v2(项目小可以不加)

3 资源名用名词

    eg：http://api.douban.com/v2/movie/

名词：movie，user...

4 记录很多时，URL加参数进行过滤

5 服务返回状态吗及提示

状态码：2 系正常返回，3系重定向， 4系资源错误，5系服务器错误

6 接口安全 

   API的身份认证应该使用OAuth 2.0框架（不想用也可以）

   技术团队自己约定的规则

    。增加两个参数time，token

    。time请求时间戳，用于验证接口请求是否超时

    。token为时间戳加密后的字符串，加密规则只有你们技术团队自己知道

 

SDL大华
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
推荐国产神器Eolink，提升API管理效率
dvlinker的技术专栏
11-14 2477
推荐国产神器Eolink，提升API管理效率
深入理解HTTP协议
Josvin
08-06 5047
目标： 掌握 http 原理，重点掌握 http Request & Response 格式 掌握 http 中相关重点知识，如请求方法，属性，状态码等 使用 java socket 编写简易版本 http server , 深刻理解原理 掌握session和cookie 1、HTTP原理 理解为何要有应用层？ 我们已经学过 TCP/IP , 已经知道目前数据能从客户端进程经过路径选择跨网络传送到服务器端进程[ IP+Port ],可是，仅仅把数据从A点传送到B点就完了吗？这就好比，在淘宝上买了
RESTful API接口规范
mj280824108的博客
07-06 733
域名 用api关键字来标识接口url https://api.example.com https://example.org/api/ 注：看到api字眼，就代表该请求url链接是完成前后台数据交互的 版本 \1. 将版本信息放在URL中，如： ​ https://api.example.com/v1/ ​ https://api.example.com/v2/ ​ v1，v2代表不同数据版本的提现，前提是一种数据资源有多个版本 \2. 将...
http api设计规范
glowd的专栏
07-11 7222
规范 api 接口必须加版本号，初始版本 【v1】,多个版本api版本可能同时在线 不使用rest的PUT和DELETE，因为很多浏览器不支持，很多框架也不支持 POST在需要传输大量数据的时候使用，其余使用GET就可以了； 这里GET和POST没有明确的含义，GET也可以新增 所有路径path全部小写，以下划线分隔，所有参数，包括POST里面的body，以及header使用驼...
RESTful 标准接口教程
weixin_42529485的博客
04-12 3553
如何利用 RESTful 标准写漂亮的 API 接口？
Restful接口规范
weixin_43880061的博客
07-26 4099
注一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范https//api.baidu.com/delete-user。-路飞的接口https//api.luffycity.com/api/v1/course/free/-https//api.baidu.com/books/1-delete请求删除主键为1的书。limit=10指定返回记录的数量。-https//api.baidu.com/books/1-get请求获取主键为1的书。...
RESTful接口API设计规范
kenabove的专栏
11-01 1万+
最近需要使用RESTful的软件架构风格编写webapi接口，参考很多RESTful文档，认识RESTful的接口规范，特此作下笔记。
学习笔记-Spring Boot 开发 RESTful Web API（一）
天外来客
08-11 1万+
题记： 本篇是Spring Boot 开发学习系列中基础知识学习的一部分，为 RESTful Web API 相关基础知识，为实践操作奠定理论基础。 REST不是一个标准，而是一种软件应用架构风格。基于SOAP的Web服务采用RPC架构，如果说RPC是一种面向操作的架构风格，而REST则是一种面向资源的架构风格。 REST是目前业界更为推崇的构建新一代Web服务（或者Web API）的架构风...
web service学习笔记1
08-08
SOAP-based Web Service提供了强大的规范和框架，适合复杂的业务需求和安全性要求，而RESTful-based Web Service则以简洁、高效和易于实现的特点，广泛应用于现代Web应用和API设计中。两者各有优劣，开发者应根据...
BTP Integration Suite学习笔记 - (Unit1) Developing with SAP Integration Suite
07-11 825
一图理解什么是分布式体系架构：分布式的架构中包括很多子系统，这些子系统在特定体系结构的框架内耦合在一起，并协同处理任务。不同的传输协议发布管理监控错误识别和纠正延迟服务质量安全可实施性可观察性文档API就是解决办法中最重要的一种。云原生架构就是基于API。练习场景一家公司向终端客户销售商品。由于全球发货问题，部分产品无法按时发货。应该通知订购这些产品的客户延迟交货的情况。（1）（2）（3）分别是产品清单，员工，和流程开始。
URL rewrite (v2)
07-11
URL rewrite (v2) IIS的请求地址重写组件
大华播放SDK开发手册.doc
08-07
此文档是关于大华播放SDK相关的开发手册，具体的SDK内容可以在大华官网下载。
大华摄像头二次开发工具及插件.zip
10-31
包含ocx控件RealPlayX.ocx，官方插件webplugin.exe，二次开发使用 WEB32网页调用接口说明（v1和v2），云台控制参数等
如何更优雅管理API接口版本（v1/v2/v3…）
热门推荐
追风2019
04-24 1万+
一、前言 一个web项目中，随着需求的变更或增加，API接口也会跟着变化，而如果APP发布后，已使用的接口肯定不能直接覆盖更新，需要新增升级版本接口和新的APP版本对应，因此多个版本接口更替后，如何更优雅管理不同版本接口代码，如何设计更直观的接口文档呈现给app端，这是我们后端工程师需要考虑的事情，下面总结接口版本管理经验。 二、接口代码版本规范 考虑到接口今后一定会进行版本迭代，因此一开始...
tp5.1定义API版本号
qq_38253703的博客
08-07 1359
目录结构如图： 路由如下： 访问URL：http://localhost/api/v1/banner/1 这样就只需要客户端调整修改v1或v2的参数就可以调用我们不同版本的控制器。 扩展问题：为什么需要版本号？ 因为当我们的产品有新版本的时候，一些老的版本的接口我们可能就不再支持使用了，可以删除掉我们以前写的接口的代码，然后写新的代码，但是互联网产品一定要考虑对老版本的兼容性问题，有点用户是不...
URL路径名+参数名+版本号 命名 经验总结（Restful最佳实战）
li_tiantian的博客
08-11 8621
每个资源使用两个URL     资源集合使用一个URL，具体某个资源用一个URL     推荐：         */employees      资源集合的URL 用名词的代替动词表示资源     不推荐：         ~~/getAllEmployees~~         ~~/getAllExternalEmployees~~         ~~/createEmployee~~ ...
API中的url增加版本号
qq_34196965的博客
09-10 2744
1、定义注解：@ApiVersion @Target({ElementType.METHOD,ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Mapping public @interface ApiVersion { /** * 标识版本号 * @return */ ...
api接口设计
jasonhui512的博客
11-12 1万+
写过不少接口，不过一直没有去总结，网上搜了一下，大同小异，此文根据以下几个链接整理修改： https://segmentfault.com/a/1190000004051246 http://blog.sqrtthree.com/2015/09/08/api/ http://keeganlee.me/post/architecture/20160107 https://www.hutuse
iis 具有 URL 重写 v2 和应用程序请求路由的反向代理
w710537643的博客
05-18 697
官方文档 微软官方文档地址：https://docs.microsoft.com/en-us/iis/extensions/url-rewrite-module/reverse-proxy-with-url-rewrite-v2-and-application-request-routing 模块下载 iis 重写下载模块地址： https://www.iis.net/downloads/microsoft/url-rewrite 安装后会有这个模块 iis 部署 django + vue (使用反向代理
restful api设计规范
最新发布
09-02
RESTful API设计规范是一种用于构建可扩展、灵活且易于理解的API架构风格。以下是一些常见的RESTful API设计规范： 1. 使用合适的HTTP方法：根据操作类型选择合适的HTTP方法，如GET用于获取资源，POST用于创建资源，PUT用于更新资源，DELETE用于删除资源。 2. 使用合适的URI：URI应该被设计成有意义且易于理解的结构。使用名词来表示资源，避免使用动词或操作。 3. 使用合适的HTTP状态码：根据操作的结果返回合适的HTTP状态码。例如，200表示成功，201表示资源创建成功，404表示资源不存在等。 4. 使用版本控制：在URI中包含版本号来管理API的变化，以保持向后兼容性。 5. 使用合适的HTTP头部信息：使用适当的HTTP头部信息来提供额外的元数据，如Content-Type和Accept用于指定请求和响应的数据格式。 6. 使用合适的错误处理机制：对于错误情况，返回合适的错误码和错误信息，并提供清晰的错误处理机制。 7. 使用过滤、分页和排序：对于大量数据的查询，提供过滤、分页和排序的功能，以提高性能和用户体验。 8. 使用合适的安全机制：对于敏感数据或操作，使用适当的身份验证和授权机制，如OAuth2.0。 9. 提供合适的文档和示例：为API提供清晰、详细的文档和示例，以便开发者能够快速理解和使用API。 10. 遵循HATEOAS原则：为API提供超媒体驱动的链接，使客户端能够通过链接发现和导航API的资源。 这些是常见的RESTful API设计规范，根据具体项目需求和团队约定，可能会有所调整和扩展。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

SDL大华

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值