RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计 http请求方法 RESTful API 设计规范 关于「能愿动词」的使用 为了避免歧义，文档大量使用了「能愿动词」，对应的解释如下...的根入口点应尽可能保持足够简单，这里有两个常见的 URL 根例子： https://api.example.com/* https://example.com/api/*...如果你的应用很庞大或者你预计它将会变的很庞大，那 应该 将 API 放到子域下（api.example.com）。...你 必须 在引入新版本 API 的同时确保旧版本 API 仍然可用。...如 API 设定为 60次/分钟，当用户在一分钟内请求次数超过 60 次后，都 应该 返回该状态码。
上个月写了一个团队中的 BaaS API 的设计规范，给大家分享下： 目录 1. 引言... 4 1.1. 概要... 4 1.2. 参考资料... 4 1.3. 阅读对象... 4 1.4....API 设计规范... 5 2.1. 地址格式... 5 2.2. 输入与输出... 6 2.2.1. 通用输入数据... 6 2.2.2. 主体输入... 6 2.2.3....并使得所有 API 尽量靠近业界规范的同时，提高API的易用性、可读性、兼容性等，并方便平台的使用者更快地发现、熟悉所有API以供开发。...主要包含两个方面的规范：API 本身的设计规范、API 帮助文档的编写规范。 1.2. 参考资料 《Representational State Transfer (REST)》 1.3....API 设计规范 2.1.
在当前流行的前后端分离架构，人们发现原来这套用于超文本传输的协议是如此适合用于设计基于互联网的api接口，基于http动词以及标准的http status返回信息，能够非常好地描述api的特性，并且可读性非常好...更重要的是，由于http是事实上的互联网通讯标准协议，基于rest设计的api接口，就好像你出国用英语和别人交流，完全不存在沟通障碍。...接口，实现对这张图片的删除操作，这个api应该怎么设计？...根据rest的设计规范，很容易得出是 [DELETE] http://jane.com/img/car 严格地说，有些网址最后的".html"后缀名是不必要的，因为这个后缀名表示格式，属于"表现层"范畴...除了HTTP METHOD,rest另外一套重要的规范就是HTTP STATUS，这套状态码规范定义了常规的api操作所可能产生的各种可能结果的描述，遵循这套规范，会使得你的api变得更加可读，同时也便于各种网络
作者：马一特 cnblogs.com/mayite/p/9798913.html RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。...本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。...: "2130040" } } 3xx 状态码 API 用不到301状态码（永久重定向）和302状态码（暂时重定向，307也是这个含义），因为它们可以由应用级别返回，浏览器会直接跳转，API 级别可以不考虑这两种情况...举例来说，GitHub 的 API 都在 api.github.com 这个域名。访问它，就可以得到其他 URL。 { ......"feeds_url": "https://api.github.com/feeds", "followers_url": "https://api.github.com/user/followers
概述 这篇文章分享 API 接口设计规范，目的是提供给研发人员做参考。 规范是死的，人是活的，希望自己定的规范，不要被打脸。...platform 平台 iOS、Android system 系统 ios 13.3、android 9 device 设备型号 iPhone XR、小米9 udid 设备唯一标示 apiVersion API
下面我们就来讨论下常用的一些API设计的安全方法，可能不一定是最好的，有更牛逼的实现方式，但是这篇是我自己的经验分享....value保存到缓存服务器中(redis)，当一个请求过来后，服务器就去缓存服务器中查询这个Token是否存在，存在则调用接口，不存在返回接口错误，一般通过拦截器或者过滤器来实现，Token分为两种： API...接口调用方(客户端)向接口提供方(服务器)申请接口调用账号，申请成功后，接口提供方会给接口调用方一个appId和一个key参数 客户端携带参数appId、timestamp、sign去调用服务器端的API...TokenController @Slf4j @RestController @RequestMapping("/api/token") public class TokenController {...@Autowired private RedisTemplate redisTemplate; /** * API Token * * @param
Open API 和前端页面一样，一直都是产品的门面， Open API 不规范，会拉低产品的专业性。...API 开放标准可供我们参考，一些开源产品的 Open API 文档也都非常完善。...本文将围绕诸多因素，尝试探讨出一份合适的 Open API 开放规范。 Open API 设计考虑因素 一个完善的 Open API 规范到底应该规范哪些东西？...站在行业角度，需要考虑提供 Open API 的产品所在的市场是否已经成熟，API 风格可能已经有了对应的规范。 站在产品角度，每个产品适合的 API 风格是不同的，下文会着重探讨这一角度。...时，整体风格一致，模块清晰 综上，在设计风格选择上，我计划采取 RPC 的设计规范。
前言 越来越多的Web应用程序使用JSON作为API的一种数据交换格式进行交互。本文档的目标是使HTTP JSON API的设计风格保持一致，容易被理解和维护。...一个优秀的API，应该是在其生命周期内能够持续提供稳定、易用、受信任的服务，并且在API的生命周期结束时能让其平滑的消亡。...注：RESTful API是目前比较成熟的一套Web应用程序的API设计理论，本文不对RESTful API过多介绍。.../api/v1/users?...返回结果设计经验与总结 如何设计一个优秀的API RESTful API 设计指南
本文总结了 RESTful API 设计相关的一些原则，只覆盖了常见的场景。有些规则只是针对自己项目而言，并非其他做法都是错误的。 1....Format 只用以下常见的3种body format： Content-Type: application/json POST /v1/animal HTTP/1.1 Host: api.example.org...对第三点的实现稍微多说一点： Java 服务器端一般用异常表示 RESTful API 的错误。API 可能抛出两类异常：业务异常和非业务异常。...API演进 版本 常见的三种方式： 在uri中放版本信息：GET /v1/users/1 Accept Header：Accept: application/json+v1 自定义 Header：X-Api-Version...URI失效 随着系统发展，总有一些API失效或者迁移，对失效的API，返回404 not found 或 410 gone；对迁移的API，返回 301 重定向。
RESTful是目前最流行的API设计规范，它的最大原则容易把握，但是细节不容易做对。所以本文对RESTful进行设计介绍，方便大家的理解与使用。..."id"：220400 } } 3xx状态码 API用不到301状态码（永久重定向）和 302状态码（暂时重定向，307也是这个含义），因为他们可以由应用级别返回，浏览器会直接跳转，API...API用到 3xx 状态码，主要是 303 SeeOther，表示参考另一个URL。...GitHub的API都在api.github.com这个域名下。访问它，就可以得到其他的URL。 上面的回应中，挑一个URL访问，又可以得到别的URL。...} 04 总结 今日的分享到此结束，读完本文，我们就可以在日常开发中设计出更加通俗移动的RESTful API了。
如果确定API 很简单，不会有进一步扩展，可以考虑放在主域名下，这里有两个常见的 URL 根例子： api.example.com/* example.com/api/* 版本（Versioning）...所有的 API 必须保持向后兼容，你 必须 在引入新版本 API 的同时确保旧版本 API 仍然可用。...，必须 遵守 HTTP 设计规范，必须 选择合适的 HTTP 状态码。...目前常见返回错误信息的方法有两种： 将错误详细放入 HTTP 响应首部 直接放入响应实体中 建议参考 理解RESTful架构 RESTful API 设计指南 RESETful API 设计规范...原创文章采用CC BY-NC-SA 4.0协议进行许可，转载请注明：转载自：什么是RESETful API 设计规范？
概念 本质：一种软件架构风格 核心：面向资源设计的API 解决问题： 降低开发的复杂性 提高系统的可伸缩性 例如：设计一套API，为多个终端服务。...例如：有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，那么它的资源路径应设计成如下样子。 https://api.example.com/v1/zoos //动物园资源。...使用https协议头;加入v1版本号，因为以后可能会更改api。...当然，处理RESTful API设计思想，还有最近流行的GraphQL，它是一种API查询语言，其将所见即所得的思想引入，能帮助提升开发的体验与应用的性能。...（参考：http://graphql.cn/ ） 参考 慕课教程 Restful API 的设计规范 理解RESTful架构 RESTful架构基础
这是因为RESTfull本身既然是一种设计风格，那么风格发挥的主动权自然就是在开发者身上，而且绝大多数的项目所开发的API接口都是对内或者有限对外开放的，所以对于RESTfull的实践是否合格更多取决于内部团队老大的看法
URI不应该使用动作来描述，比如createUser 2.接口数据安全性决定优先选择https协议 3.如果一个接口有多版本存在，需要在url中标识体现 假如我们刚开发一个后台，那第一个版本就是v1 api.baidu.com.../v1/ 后面接口需要升级，那么就将接口升级为v2 api.baidu.com/v2/ 4.接口操作的数据源称之为资源，在url中一般采用资源复数形式，一个接口可以概括对该资源的多种操作方式 获取全部书籍...api.baidu.com/books 获取指定的书籍 api.baidu.com/books/(pk) 5.请求方式有很多种，用一个url处理如何保证不混乱 – 通过请求方式标识操作资源的方式 获取所有书籍...pk) 整体更新一本书籍的内容，使用put请求 /books/(pk) 局部更新一本书籍的一个字段，使用patch请求 /books/(pk) 6.资源往往涉及数据的各种操作方式 – 筛选、排序、限制 api.baidu.com
二、界面图片设计比例 常见图片尺寸比例：16:9、4:3、1:1、1:0.618(黄金比例)等 三、APP版式设计规范 对齐、对称、分组 四、文字设计规范 文字是APP中最核心的元素，是产品传达给用户的主要内容...五、文字设计规范 iOS 主流设备的分辨率分别是： 640x1136px：【（@2x）iPhone SE 】 750 x1134px：【（@2x）iPhone6s/7/8 】 1242x2208px：【
有幸在刚入部门就参与设计规范制定，前前后后大概花费一个月时间。本次博文结合亲身参与的制定规范项目，围绕：设计规范的重要性，制定规范的时机，制定的过程和后续工作这几个方面来总结和分享。...设计规范的重要性 设计总监刚开始召集设计师讨论立项制作设计规范时，就有设计师提出“规范只是公司给外部看的一种噱头”，更像是体现一种公司视觉形象（VI）。...制定设计规范过程 设计规范虽然只是简单几页，但那是浓缩概括的结果，并非一蹴而就。...及时地总结对后期设计规范的制定打下良好基础，否则很容易忘记设计初衷，找不到文件或者设计负责人等等问题。 总结归纳会议 准备制作设计规范时，需要召集各产品线上的设计师将设计结果进行汇总和提炼。...规范标准 先看几个优秀的设计规范：微信weui与weui文档；Ant Design ; Material Design；IBM Design Language 优秀设计规范拥有明确层级和逻辑，便于其他组员查找相应内容
2018也快要过完了（-_-），我们的移动端的UI设计规范也层出不穷。很多APP设计师也要在年底给公司或者是团队做一个总结。那么一个像样的APP ui设计规范也是很有必要的作品回顾。...但是我还是很有追求的在每个版本改版之后，更新设计规范。我的设计规范没有大公司那么高大上，只包含了字体选用，配色运用，ui kit这些东西。...有个设计文档和UI设计规范，可以减少很多设计与开发之间的沟通。...好了，我们言归正传，看看最新的 移动端UI设计规范模板参考吧。 UI设计规范.jpg 看完，是不是心里有底了吗？...推荐一个关于设计规范的网址：https://ds.mockplus.cn/ 来自https://www.25xt.com/appdesign/13754.html
redis缓存设计规范 一、键值设计 1、key名设计 【建议】可读性 以业务名(或数据库名)为前缀(防止key冲突)，用冒号分隔，比如业务名:表名:id的key可以设置成ugc:video:1 【建议
这个时候会需要一份交互设计规范来规范和指导产品设计，从而保证产品设计的一致性，提升整体产品质量。...本文就来说一说交互设计规范应该包含的一些内容： 一、页面信息规范 页面信息规范主要指页面的静态信息应该遵循的规则，包括： 1.标题规范 用于规定整个产品中所有不同层级不同功能的页面应该使用的标题的规则
继前面一章《RobotFramework环境搭建》介绍了在本地如何将接口自动化实施过程所需要的基础环境搭建好，在这里假设大家都已经知道环境如何搭建了，如果不清...
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
即时通信 IM
ICP备案
对象存储
实时音视频
