腾讯阿里原来是这样设计api的

最新推荐文章于 2024-06-11 11:23:17 发布
最新推荐文章于 2024-06-11 11:23:17 发布
阅读量697 收藏
点赞数
分类专栏： 互联网金融 文章标签： api 程序设计
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/mistakk/article/details/115980378
版权
本文分析了大厂API的设计思路，包括RESTFUL风格、返回码、数据交互格式、同步异步接口等设计规范。讨论了API的可用性，如幂等性、超时时间、限流机制。还探讨了安全性，涉及XSS攻击的防御和数据认证方法。
摘要由CSDN通过智能技术生成

大厂如何设计api

本文参考微信和支付宝的API设计，从「设计」，「可用性」，「安全性」三个方面分析API的设计思路；其中「设计篇」是设计一个api需要考虑哪些因素，「可用性」是一个api高可用的背后需要完成哪些技术点，「安全性」是API如何实现相互认证、安全通信等安全目标。

设计篇

RESTFUL风格

RESTFUL是一种API风格或者是规范，它有一些建议和规范指导如何设计好的API，到2010 年，大约 74% 的公共网络 API 是 HTTP REST的 API。

REST定义了一系列的标准方法，如Get、Post、Create、Update、Delete、List等，来对资源的操作。

下面是官方文档中两个比较好的参考资料：

API规范定义

返回码标识

返回码标识决定了这一次的请求是否是成功的，如果是非成功的那是因为什么原因失败了。
如Alibaba: API列表中可以看到，错误码InvalidTemplateName.Malformed标记了模板名格式不正确，模板名不能大于30个字符；只有给出良好错误码信息，才便于使用者进行调试与开发

数据交互格式

指定你的数据交互格式，比如json或者xml。

举例这里是微信支付: 下单API，我们可以看到它的数据交互格式是json。

同步、异步接口

业务定义

首先需要了解同步、异步业务的具体含义：

  • 同步：请求在发出后，双方一直维持连接；直到对端返回数据或者超时断开
  • 异步：请求在发出后，对方回复确认收到请求即
最低0.47元/天 解锁文章
内核手记
关注
专栏目录
阿里巴巴开发规范.docx
08-06
阿里巴巴开发规范 一、编程规约 1 (一) 命名规约 1 (二) 常量定义 3 (三) 格式规约 4 (四) OOP 规约 6 (五) 集合处理 10 (六) 并发处理 12 (七) 控制语句 15 (八) 注释规约 16 (九) 其它 17 二、异常日志 19 (一) 异常处理 19 (二) 日志规约 20 三、MySQL 规约 22 (一) 建表规约 22 (二) 索引规约 23 (三) SQL 规约 25 (四) ORM 规约 26 四、工程规约 27 (一) 应用分层 27 (二) 二方库规约 28 (三) 服务器规约 30 五、安全规约 31
阿里研究员谷朴：API 设计最佳实践的思考
weixin_34185320的博客
12-28 269
API是软件系统的核心，而软件系统的复杂度Complexity是大规模软件系统能否成功最重要的因素。但复杂度Complexity并非某一个单独的问题能完全败坏的，而是在系统设计尤其是API设计层面很多很多小的设计考量一点点叠加起来的（也即John Ousterhout老爷子说的Complexity is incremental【8】）。成功的系统不是有一...
转载：阮一峰 RESTful API设计指南
diaojian0245的博客
09-09 254
阮一峰先生的文章对我理解启发很大，转载到我的博客 http://www.ruanyifeng.com/blog/2014/05/restful_api.html 网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。 因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"AP...
接口（API）设计规范
qq_41186565的博客
12-12 2437
公共参数是每个接口都要携带的参数，描述每个接口的基本信息，用于统计或其他用途，放在header或url参数中。
原来阿里华为等大厂都是这么设计微服务接口的!
JavaEdge全是干货的技术号
01-17 1506
接口设计需考虑到： 命名 参数列表 包装结构体 接口粒度 版本策略 幂等性实 同步/异步处理 微服务架构下，如果接口设计思路和调用方理解不一致，就会导致很多问题。 接口的响应要明确接口的处理结果 某下单接口响应体包含 success code info message 二级嵌套对象data结构体 有时下单操作的响应结果是： success=true、message=OK，貌似代表下单成功 但info却提示订单存在风险，code是个1001错误码，data中能看到订单状态是Cancelled，订单ID
Text-Sensitivity:整合阿里云与腾讯云的敏感词检测API
04-30
整合来自阿里云和腾讯云两大敏感词汇检测 API ，检测词汇采用双锁机制，当两大 API 均认为输入词汇是正常词汇时，才认定为正常词汇。 配置与使用 npm install ct-sensitivity --save 本工具使用 Promise 封装，在...
Java调用腾讯云短信API接口的实现
08-18
Java调用腾讯云短信API接口的实现 Java调用腾讯云短信API接口的实现，是指使用Java语言调用腾讯云短信API接口发送短信的过程。本节将详细介绍Java调用腾讯云短信API接口的实现步骤和示例代码，对大家的学习或者工作...
阿里云/腾讯云短信发送（C#版）
02-24
阿里云和腾讯云短信发送服务是企业级应用中常见的通讯工具，主要用于验证码、通知消息以及营销推广等场景。本文将详细讲解如何使用C#语言在.NET 4.5框架下集成这两个云服务进行短信发送。 首先，我们需要了解阿里云...
Java基于腾讯云短信和阿里云短信整合的一个简单demo.zip
06-01
6. **API集成**: 这个项目展示了如何将外部服务（如腾讯云和阿里云的短信服务）的API集成到Java应用中。这通常涉及到创建HTTP请求，处理响应，以及错误处理和重试策略。 7. **多供应商策略**: 在实际应用中，有时会...
阿里云合作伙伴API 规范 V1.3.3
04-10
Legal Disclaimer........................................................................................................................................................... I Preface ......................................................................................................................................................................... II Table of Contents ........................................................................................................................................................ III 1. Introduction ......................................................................................................................................................... 6 1.1. Glossary.................................................................................................................................................... 6 2. Revision History .................................................................................................................................................... 7 3. Scenario Overview ............................................................................................................................................... 8 3.1. Account Management.............................................................................................................................. 8 3.1.1. Account Status ............................................................................................................................. 8 3.1.2. Account Actions ........................................................................................................................... 8 3.1.2.1. 3.1.2.2. 3.1.2.3. 3.1.2.4. Activate ............................................................................................................................ 9 Enable, Suspend, Disable, Delete..................................................................................... 9 Set/Get Hosting Status................................................................................................... 10 SSO ................................................................................................................................. 12 3.2. Credit Limit............................................................................................................................................. 13 3.3. Billing Statement .................................................................................................................................... 13 3.4. Ticket System (Draft) .............................................................................................................................. 13 3.5. Event Notification................................................................................................................................... 15 3.6. Pricing Info and Realtime Enquiry (Draft) .............................................................................................. 15 3.7. Admin Management (Beta).................................................................................................................... 15 4. API Overview ...................................................................................................................................................... 16 4.1. Account Management............................................................................................................................ 17 4.2. Credit Limit............................................................................................................................................. 17 4.3. Billing Statement .................................................................................................................................... 17 4.4. Ticket System (Draft) .............................................................................................................................. 17 4.5. Event Notification................................................................................................................................... 18 4.6. Pricing Info (Draft) .................................................................................................................................. 18 4.7. Admin Management .............................................................................................................................. 18 4.8. Data Type ............................................................................................................................................... 18 4.9. Error Info ................................................................................................................................................ 18 5. API Call Methods ................................................................................................................................................ 19 5.1. 5.2. 5.3. Request Structure .................................................................................................................................. 20 5.1.1. Service Address .......................................................................................................................... 20 5.1.2. Communication Protocol ........................................................................................................... 20 5.1.3. Request Methods ....................................................................................................................... 20 5.1.4. Request Parameters ................................................................................................................... 20 5.1.5. Character Encoding .................................................................................................................... 20 Public Parameters .................................................................................................................................. 20 5.2.1. Public Request Parameters ........................................................................................................ 20 5.2.2. Public Return Parameters .......................................................................................................... 21 Returned Results .................................................................................................................................... 21 5.3.1. Successful Results ...................................................................................................................... 22 Version:1.3.0 III Alibaba Cloud Partners API Documentation/Table of Contents 5.3.2. Error Results............................................................................................................................... 22 5.4. Signature Mechanism ............................................................................................................................ 23 6. API References.................................................................................................................................................... 25 6.1. 6.2. 6.3. 6.4. 6.5. 6.6. 6.7. 6.8. Account Management............................................................................................................................ 25 6.1.1. CreateAccount............................................................................................................................ 25 6.1.2. GetAccountInfo .......................................................................................................................... 25 6.1.3. QueryAccounts........................................................................................................................... 25 6.1.4. SetAccountStatus ....................................................................................................................... 26 6.1.5. CreateSsoLoginUrl ...................................................................................................................... 26 6.1.6. SetHostingStatus ........................................................................................................................ 26 6.1.7. GetHostingStatus ....................................................................................................................... 27 Credit Limit............................................................................................................................................. 27 6.2.1. InitializeCreditLimit .................................................................................................................... 27 6.2.2. GetCreditLimitInfo ..................................................................................................................... 28 6.2.3. SetCreditLimit ............................................................................................................................ 28 6.2.4. SetWarningThreshold ................................................................................................................ 28 6.2.5. ClearCreditBalance..................................................................................................................... 29 Billing Statement .................................................................................................................................... 29 6.3.1. QueryResellerDailySubscription................................................................................................. 29 6.3.2. QueryResellerDaliyPAYG............................................................................................................. 30 6.3.3. QueryEndUserDailySubscription ................................................................................................ 30 6.3.4. QueryEndUserDailyPAYG............................................................................................................ 31 6.3.5. QueryResellerMonthSummary .................................................................................................. 31 6.3.6. QueryEndUserMonthSummary ................................................................................................. 32 Ticket System (Draft) .............................................................................................................................. 32 6.4.1. CreateTicket ............................................................................................................................... 32 6.4.2. QueryTickets .............................................................................................................................. 33 6.4.3. CreateTicketReply ...................................................................................................................... 34 6.4.4. GetTicketReplies......................................................................................................................... 34 6.4.5. QueryTicketProducts.................................................................................................................. 34 6.4.6. QueryProductFAQs..................................................................................................................... 35 6.4.7. GetAttachmentTempUrl............................................................................................................. 35 Event Notification................................................................................................................................... 35 Pricing Info (Draft).................................................................................................................................. 35 6.6.1. GetRegions ................................................................................................................................. 35 6.6.2. GetProducts ............................................................................................................................... 36 6.6.3. GetComponents ......................................................................................................................... 36 6.6.4. GetPrice...................................................................................................................................... 36 6.6.5. EnquiryRealtimePrice................................................................................................................. 36 Admin Management .............................................................................................................................. 38 6.7.1. CreateAdminAccount ................................................................................................................. 38 6.7.2. GetAdminAccountInfo ............................................................................................................... 38 6.7.3. QueryAdminAccounts ................................................................................................................ 39 6.7.4. SetAdminAccountStatus ............................................................................................................ 39 Data Type ............................................................................................................................................... 39 6.8.1. JsonArrayString .................................................................................................................... 39 Version:1.3.0 IV Alibaba Cloud Partners API Documentation/Table of Contents 6.9. 6.8.2. DateType .................................................................................................................................... 39 6.8.3. AccountType............................................................................................................................... 39 6.8.4. AkType........................................................................................................................................ 40 6.8.5. TicketType .................................................................................................................................. 40 6.8.6. TicketStatusType ........................................................................................................................ 40 6.8.7. TicketReplyType ......................................................................................................................... 40 6.8.8. TicketProductType...................................................................................................................... 40 6.8.9. TicketProductFaqType ................................................................................................................ 41 6.8.10. AdminType ............................................................................................................................... 41 6.8.11. RellserDailySubscriptionType................................................................................................... 41 6.8.12. RellserDailyPAYGType............................................................................................................... 42 6.8.13. EndUserDailySubscriptionType ................................................................................................ 42 6.8.14. EndUserDailyPAYGType ............................................................................................................ 43 6.8.15. ResellerMonthSummaryType .................................................................................................. 43 6.8.16. ResellerMonthPordSummaryType ........................................................................................... 43 6.8.17. EndUserMonthSummaryType.................................................................................................. 44 Error Info ................................................................................................................................................ 44 6.9.1. Common Error Codes................................................................................................................. 44 6.9.2. Http Status Codes....................................................................................................................... 44 7. References.......................................................................................................................................................... 44
淘宝客开放api使用完整实例demo
10-31
使用淘宝开放平台api搭建的一个淘宝客的网站，个人开发，供大家学习
阿里巴巴Java开发规范手册
weixin_30685029的博客
02-07 275
Java开发手册 版本号 制定团队 更新日期 备注 1.0.0 阿里巴巴集团技术部 2016.12.7 首次向Java业界公开 一、编程规约 (一)命...
【菜狗学前端】在原生微信小程序使用腾讯地图API接口
最新发布
m0_58355897的博客
06-11 1143
在原生微信小程序中调用腾讯地图API的个人总结。 (基于最近写的获取附近餐厅、搜索目标地点并进行导航这个实验)
商城API下单接口逻辑
weixin_46089846的博客
06-05 1143
商城下单接口被认为是整个项目中最复杂与最须谨慎处理的一个接口，为大家梳理下主链的通用逻辑，供参考与启发。
接口设计六大原则
qq_33624126的博客
05-21 265
一.单一职责原则 Single Responsibility Principle, 简称SRP。 定义：There should never be more than one reason for a class to change. 应该有且仅有一个原因引起类的变更。 职责的划分？单一的定义和级别？ 应该根据实际业务情况而定。关注变化点。 实际使用时，类很难做到职责单一，但是接口的职责应该尽量单一。 二.里氏替换原则 Liskov Substitution Princip...
接口设计原则（安全方面）
紫一的博客
03-30 726
接口设计原则（安全方面） 1.数据有效性校验 常规性校验：包括必填字段，长度检测。格式校验等。 鉴权校验：当前请求必须符合权限等。 业务校验：根据实际业务而定，比如订单金额不能小于0等等。 作用：在接口层做用户鉴权校验和参数校验，比如做ID基础校验，id<0 直接拦截这样就很有效的能够解决恶意请求从而导致缓存击穿的问题。这里有一个小细节，就是我们开发的时候要保持一个不信任的心，就是不要相信任何的调用方，比如你提供了一个API接口出去，有几个参数。我觉得作为被调用方，任何可能的参数都应该被考虑到
人工智能api 百度 腾讯 阿里
01-12
人工智能API是指人工智能技术公司提供的应用程序编程接口，用于让开发者能够使用这些公司的人工智能技术进行开发和应用。百度、腾讯和阿里是国内三家知名的互联网巨头，它们也提供了人工智能API。 百度的人工智能API主要有语音识别、人脸识别和自然语言处理等。语音识别API可以将语音转换为文字，支持多种语言和方言，可以应用于语音翻译、语音搜索等场景。人脸识别API可以识别人脸的性别、年龄、表情等信息，可以应用于人脸验证、人脸检索等场景。自然语言处理API可以对文本进行分词、词性标注、情感分析等处理，可以应用于智能客服、文本分类等场景。 腾讯的人工智能API主要有图像识别和机器翻译等。图像识别API可以识别图片中的物体、场景、文字等信息，可以应用于图像搜索、智能广告等场景。机器翻译API可以将文本进行自动翻译，支持多种语言，可以应用于在线翻译、多语种交流等场景。 阿里的人工智能API主要有人脸识别、语音合成和机器学习等。人脸识别API可以识别人脸的年龄、性别、表情等信息，可以应用于人脸验证、人脸检索等场景。语音合成API可以将文字转换为语音，支持多种语音风格和音色，可以应用于智能播报、语音导航等场景。机器学习API可以根据数据进行模型的训练和预测，可以应用于推荐系统、广告投放等场景。 总之，百度、腾讯和阿里的人工智能API提供了丰富的功能和接口，为开发者提供了丰富的人工智能技术支持，帮助开发者快速构建和应用人工智能相关的应用程序。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值