App后台开发运维和架构实践学习总结（3）——RestFul架构下API接口设计注意点

最新推荐文章于 2023-11-05 01:59:47 发布
最新推荐文章于 2023-11-05 01:59:47 发布
阅读量2.9k 收藏 1
点赞数
分类专栏： App后台开发运维和架构实践学习总结 App后台
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u012562943/article/details/53228082
版权
本文总结了API设计中的8个关键点，包括保持相容性和统一性、提供明确的反馈、简化请求流程、正确使用响应状态码、考虑性能优化、使用安全认证方式、实施版本控制以及选择JSON作为数据格式。遵循这些原则可以提升API的用户体验和性能。
摘要由CSDN通过智能技术生成

1. 争取相容性和统一性

这里就要求让API设计得是可预测的。按照这种方式写出所有接口和接口所需要的参数。现在就要确保命名是一致的，接口所需的参数顺序也是一致的。你现在应该有products，orders和customers的数据吧？，它们应该都存在含有id和name的表中。那么不要让一个接口仅传ID而另一个仅传name还有的两个都要传。也不要让一个接口按照/product/ID传参而另一个接口按/ID/customer这样传参。因为作为一个API的使用者我希望以相同的方式访问两个不同的资源。

了解本专栏 订阅专栏 解锁全文 超级会员免费看
一杯甜酒
关注
专栏目录
订阅专栏
App后台开发运维和架构实践学习总结（7）——RESTful API 设计规范
科技D人生
05-06 1884
一个好的API设计，是应该遵循资源导向的，需要见名知义。 一、协议 API与用户的通信协议，总是使用HTTPs协议。 二、域名 应该尽量将API部署在专用域名之下。 https://api.example.com 如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。 https://example.org/api/ 三、版本（Versioning） ...
App后台开发运维和架构实践学习总结（3）——RestFul架构下API接口设计注意点...
weixin_33861800的博客
11-19 107
1. 争取相容性和统一性 这里就要求让API设计得是可预测的。按照这种方式写出所有接口和接口所需要的参数。现在就要确保命名是一致的，接口所需的参数顺序也是一致的。你现在应该有products，orders和customers的数据吧？，它们应该都存在含有id和name的表中。那么不要让一个接口仅传ID而另一个仅传name还有的两个都要传。也不要让一个接口按照/product/ID传参而另一...
App后台开发运维和架构实践学习总结（2）——RESTful API设计技巧
weixin_34102807的博客
10-29 107
前言 移动互联网时代，RESTful API成为越来越重要的移动端和服务器端交互的形式。尤其是在很多互联网公司或者传统行业拥抱移动互联网的时候，一套设计良好的Restful API能够帮助互联网产品支持单服务端＋多客户端的场景。RESTful架构本身是一个风格而不是一个标准，这也就意味着在具体设计时会有不同的实现。那么什么是好的RESTful API呢？笔者认为适合的是最好的，能够根据本...
《App后台开发运维和架构实践》推荐序
热门推荐
曾健生的专栏
06-05 1万+
软件开发工具的成长速度远远超过开发人员的成长速度，这是现实。 每个月，甚至每天，我们都可以见到新的类库、框架、工具、语言。它们或者极大地降低了开发的成本，或者极大地提升了开发的效率。 随之而来的问题就是，如何让开发人员妥善地运用好这些工具？曾经有好几个做开发的同事跟我说：“写软件谁不会？从网上找些开源的类和项目来改改就是了”。目前也确实充斥着这种“改改就是”的工作思维。介绍某个类库和项目如何安装
兼容性设计
扈晓炜的专栏
04-27 1425
<br /><br />兼容性的意义<br />产品兼容性指产品与其他产品具有类似的操作 , 能够处理其他产品产生的数据 , 处理结果能够被其他产品继续处理 . 从兼容的产品角度包括与竞争产品兼容 , 与相关产品兼容 , 与以前产品兼容 , 与以后产品兼容 . 兼容性是产品市场战略的重要部分 . 严重影响产品的市场发展和开发成本 . 产品架构师需要设计兼容性方案 , 以合理的成本实现市场要求的产品兼容性 .<br />
Spring Cloud与微服务学习总结（7）——Spring Cloud微服务架构实践与经验总结
科技D人生
07-13 5305
前言 突然看到这个一个问题《Spring Cloud在国内中小型公司能用起来吗？》。好问题。好问题必须配认真的回答，仔细的看了题主的问题，发现这个问题非常具有代表性，可能是广大网友想使用Spring Cloud却又对Spring Cloud不太了解的共同想法，题主对Spring Cloud使用的方方面面都进行过了思考，包括市场，学习、前后端、测试、配置、部署、开发以及运维。 想要明白这个问题，首...
开放平台架构设计原理与实战：构建持续开放的开放平台开发流程
最新发布
程序员光剑
11-05 237
近年来，互联网经济蓬勃发展，人们越来越重视对自己信息的掌控权，希望在不受限制地分享自己的知识、经验和创造力。而早已开始普及的微信、微博、知乎等社交媒体则成为人们获取信息、沟通感情、表达观点的主要渠道。如此开放的网络空间也给平台创作者提供了巨大的想象空间。然而，当平台创作者构建自己的平台时，也面临着更复杂的技术难题——如何构建可持续、可扩展、安全的开放平台？如何让平台上的用户持续地提供新的价值？更重要的是，如何将平台上生成的数据产生价值，并且持续地推动平台运营？
SpringBootActuator自动化运维工具介绍
程序员光剑
07-30 1188
2020年，开源软件成为云计算、DevOps领域的主要驱动力之一。作为一个开源软件开发平台，Spring Boot的出现也对Java生态圈起到了至关重要的作用。Spring Boot已经成为最流行的Java开发框架之一，其开箱即用的特性以及强大的扩展性都吸引了越来越多的开发者和企业用户。在Spring Boot中，有一个非常实用且灵活的模块Actuator。
应对嵌入式系统设计中的接口不兼容性
10-26
本文将简要介绍嵌入式系统设计领域中占主要地位的数字通信接口和协议，随后将讨论三种常见的接口不兼容性问题以及有关的解决方法。最后，本文将为嵌入式系统设计人员提供一些如何避免或解决接口不兼容性问题的建议。
结构型设计模式(一) 之 适配器模式使接口兼容更好
子云心的博客
08-27 510
1 定义 适配器模式（Adapter Pattern）属于结构型设计模式之一，它主要用于处理不兼容的两个接口的协同工作，使一个接口转换成期望的另一个接口。例如现实场景中，手机充电器便是一个适配器，它将220V的电压转换成我们手机需要的5V电压、又例如读卡器也是一个适配器，它将SD卡转换成电脑的USB插口。在代码使用上，适配器模式其实就是增加一个适配器的类作为中间类将不兼容的接口转变成调用者需要的接口。 2 实现 适配器模式一般包含3个角色，分别是： 被适配者（Adaptee），就是原有已存在的需要适
写一个函数接口, 能够实现对小数和整数的排序
persistence_Y的博客
10-11 136
#include <iostream> using namespace std; void InsertSort(int * src, int n) { int i, j; int tmp; for (i = 1; i < n; ++i) { tmp = src[i]; for (j = i; j > 0 && src[j - 1] &...
桌面端应用接口版本兼容设计和使用原则
王森的博客
03-15 1591
早期开发时，由于选型架构等问题，老旧接口仍然要正常运行，需要逐步引导客户使用新版，但是接口由新团队进行开发，比如 PHP 转成了用 Go 来开发，响应更快，并发更大，新的接口又和老的接口逻辑相近，但传入传出都不相同，这种巨大差异，不应该在原版接口中改动，容易产生灾难性的影响，因此，我们会在 url 上进行处理，例如 url 中接口版本为/api/v1，等到新接口采用/api/v2，这样就有效的改善了新版用户的无缝衔接，接口版本非常少，如果公司接口版本搞得很多，绝对出问题了。
软件接口设计中的版本兼容问题处理
phoenixhdf的博客
05-30 4736
 最近在项目中经常遇到软件版本升级后不兼容旧版本的问题，本文根据以往经验，从软件接口设计、实现等方面整理了一些兼容性设计思路。1. 优化设计1）接口返回值的定义有的人喜欢用0、1等较小的数字标记返回码或其他一些常量含义，比如我接触过几个项目，使用整型常量0作为成功的返回码，在以后的使用中，可能遇到的问题是整型的缺省值为0，这种情况下逻辑上无法区分没有返回值还是返回了0，如果某天出现了此类问题...
如何优雅的进行接口设计？接口设计的六大原则是什么？
weixin_19970108018的博客
08-17 2019
如何优雅的进行接口设计？接口设计的六大原则是什么？本文关于如何优雅的进行接口设计？接口设计的六大原则是什么？作为后端开发，不管是什么语言，JavaGo还是C++，其背后的后端思想都是类似的。后面打算出一个后端思想的技术专栏，主要包括后端的一些设计、或者后端规范相关的，希望对大家日常工作有帮助哈。我们做后端开发工程师，主要工作就是：如何把一个接口设计好。所以，今天就给大家介绍，设计好接口的36个锦囊。1. 接口参数校验入参出参校验是每个程序员必备的基本素养。你设计的接口，必须先校验参数。
以Api方式设计程序的优缺点 php,PHP 数据库驱动、连接数据不同方式学习笔记
weixin_35734408的博客
03-17 282
目录1. PHP数据库驱动简介2. PHP连接数据库的不同方式1. PHP数据库驱动简介驱动是一段设计用来于一种特定类型的数据库服务器进行交互的软件代码。驱动可能会调用一些库。类似于Java中的数据库驱动的概念复制代码1. JDBC-ODPC桥:它将JDBC API映射到ODPC API。再让JDBC-ODPC调用数据库本地驱动代码(也就是数据库厂商提供的数据库操作二进制代码库，例如Oracle中...
谈谈你对rest api的认识
diwei3832的博客
10-21 142
协议 是基于http，https协议 域名 http://api.123.com存在跨域http://www.123.org/api/不存在跨域 url 都是名词视网上所有的东西都是资源 请求方式 　　　　　　　　GET -------- 从服务器取数据一条或者多条 　　　　　　　　POST --------- 去服务器添加一...
在修改接口的时候,一定要注意向下兼容
庐山烟雨浙江潮
12-22 1993
兼容性
App后台开发全攻略：实战运维与架构设计详解
《App后台开发运维和架构实践》是一本深入探讨移动互联网时代App后台开发的专业指南。该书首先明确了App后台开发的独特挑战，如实时性、并发处理能力、数据安全性和可扩展性等。它系统地梳理了各个环节的技术要点，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

一杯甜酒

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

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

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

打赏作者

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

抵扣说明：

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

余额充值