对外开放得接口设计

已于 2023-04-25 14:41:53 修改
阅读量148 收藏
点赞数
文章标签： 设计规范
于 2023-04-25 14:41:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_35491593/article/details/130364725
版权

对外开放得接口编写心得
1、 这次得部分参数也标注得不合理
2、 Swagger 文档分布得不合理,最好按照页面来提供，复用只是在service层，controller层独立，参数不复用，每个接口完全使用不一样的入参
3、 Post方法不要使用?xxx=xxx这种方式去对接参数
4、 已投入使用的接口不能修改、只能新增，否则会造成原有功能得不知名错误
5、 接口得参数必须唯一、接口间不允许复用（复用会造成接口参数得混淆）

志存高远，责任为先
关注
接口测试，接口协议以及常用接口测试工具详解
测试逍遥子的专栏
04-20 2588
一、前言：什么是接口 1.接口指的是软件提供给外界的一种服务。作用在于使其内部的数据能被外部进行修改的交互方式。 例如：USB接口，电脑里的数据可以看成是内容数据，而U盘里的数据可以看成是外部数据，那么USB接口的作用就是：电脑和U盘交互数据，也就是使电脑内部的数据能够和外部的U盘交换数据。 例如：微信的提现和充值，就调用银行对外开放的接口， 这些接口有权限控制，一般需要鉴权码token才...
api对外开放接口
zhilinboke的博客
10-31 6637
一： 对外开放接口如何保正：   请求鉴别用户身份？ 请求参数被篡改？请求的唯一性(不可复制) 2   为了防止别人重复使用请求参数问题，我们需要保证请求的唯一性，就是对应请求只能使用一次，这样就算别人拿走了请求的完整链接也是无效的。 唯一性的实现：在如上的请求参数中，我们加入时间戳 ：timestamp（yyyyMMddHHmmss），同样，时间戳作为请求参数之一，也加入sign算法中进行...
如何设计安全可靠的开放接口---之Token
自律使我自由
05-12 4129
前言 Open API是会暴露到公网被访问的接口，那与内网接口最重要的区别就是如何做好安全的问题，常见的安全问题有：合法身份判别、数据防窥、数据防篡改、请求防重放、Dos攻击等等，本文针对这些安全问题整理了一些常见的应对措施。 合法身份判别 首先，我们先来看看如何解决身份判别的问题，身份判别最简单的方式就是让用户自己注册账号、密码，然后使用账号、密码登陆成功后再进行接口请求，但是对于Open API来说一般是没有登陆这一步操作的，所以我们就需要通过另一种方式来间接的让请求用户实现登陆。 Token Toke
对外 API 接口，请把握这3 条原则，16 个小点
HelloWorld搬运工
10-23 1499
3、客户端拿到这个随机数后将其与appsecret拼接生appsecretStr，然后调用生成签名方法，传入appsecretStr，appkey，nonce，url（备注：可转大写，转小写，追加特殊字符，然后加密）进行非可逆加密（MD5/SHA1等），生成签名A。1、设计一个认证系统，专用于创建第三方接入应用的账号信息，用于生成appid,appkey和appsecret，然后发appkey和appsecret给第三方接入应用，用于做认证。5、单个接口针对IP限流（令牌桶限流，漏桶限流，计数器限流）
设计一个安全的对外开放接口+实现案例
十指演绎悲伤的博客
06-19 2284
对外开放接口
基础数据对外开放接口文档-V1.0.41
08-08
智慧园区综合管理平台的基础数据对外开放接口文档V1.0.4是为第三方厂家、合作伙伴和开发者设计的一份详细指南，旨在介绍如何利用API接口与该平台进行交互，获取和操作数据。该文档由浙江大华技术股份有限公司发布，...
WMS系统对外开放接口设计文档-V.1.0.docx
03-16
### WMS系统对外开放接口设计知识点概述 #### 一、系统概览 - **系统名称**：WMS系统（Warehouse Management System，仓库管理系统） - **开发语言**：Java - **文档版本**：V.1.0 - **文档提供方**：四川物联亿达...
巡更子系统对外开放接口文档-V1.0.11
08-08
智慧园区综合管理平台的巡更子系统对外开放接口文档V1.0.11是为第三方厂家、合作伙伴和开发者提供的重要参考资料。该文档详细介绍了如何与巡更子系统进行交互，以便集成或开发与之相关的应用和服务。文档由浙江大华...
会议子系统对外开放接口文档-V1.0.11
08-08
智慧园区综合管理平台会议子系统的对外开放接口文档V1.0.11是浙江大华技术股份有限公司提供的一项重要技术资料。该文档详细阐述了会议子系统对外提供的接口规范，供开发者集成和调用，以实现与其他系统或设备的交互...
梯控子系统对外开放接口文档-V1.0.11
08-08
梯控子系统对外开放接口文档V1.0.1是浙江大华技术股份有限公司为第三方厂家、合作伙伴和开发者提供的技术指南，旨在促进与其他系统的集成和开发工作。该文档详细阐述了梯控子系统如何通过API接口与其他软件或设备...
如何设计一个安全的对外接口?
weixin_46742102的博客
09-27 605
前言 最近有个项目需要对外提供一个接口，提供公网域名进行访问，而且接口和交易订单有关，所以安全性很重要；这里整理了一下常用的一些安全措施以及具体如何去实现。 安全措施 个人觉得安全措施大体来看主要在两个方面，一方面就是如何保证数据在传输过程中的安全性，另一个方面是数据已经到达服务器端，服务器端如何识别数据，如何不被攻击；下面具体看看都有哪些安全措施。 1.数据加密 我们知道数据在传输过程中是很容易被抓包的，如果直接传输比如通过http协议，那么用户传输的数据可以被任何人获取；所以必须对数据加密，常
项目实战之——开放接口简单封装
gu_zhang_w的博客
04-22 1219
开放接口简单封装项目由来设计目标项目结构example-open-baseexample-open-apiexample-open-sdk开放文档工具常用工具aes 数据加密算法，抽象与默认实现sgin 签名算法，抽象与默认实现签名服务提供，抽象与默认实现数据模型服务方第三方公用部分功能快捷键合理的创建标题，有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列...
开源项目 ——API接口管理平台数据库原型设计（三）
CN華少的博客
08-24 1922
开源项目 ——API接口管理平台数据库原型设计(三) 背景 日常我们开发人员在开发一些常用的平台时都会用到各种各样的接口，而对于这些接口的有效管理都会成为我们的一些麻烦事，一些常见的接口管理平台我们使用起来又不是很顺手，因此我想进行编写一个自己的API接口平台，用于我们日常的一些接口快速开发和管理共享使用。 里面会涉及到各类开发的知识，每项知识我们都会进行同步发布相应的学习记录文章，以便于想...
对外开放接口的Appkey和Secret应该如何设置？
最新发布
技术分享博客
03-25 1445
123456 MD5加密后就生成了32位或者64位的字符串，再将其拆分为若干段，例如拆分成三段，每段有多少个，然后生成一个2000随机乱码字符串中，将secret 插入到2000个字符串中的固定位置，然后检查乱码字符串长度是否附后，然后substring拆你要的加密字符串，然后解密出来看是否能得到原来的明文。在对外开放接口的设计中应该要考虑到接口的安全性和可扩展性。App secret:的意思为“私匙”，简称api接口密钥，是跟app key配套使用的，可以简单理解成是密码，它是微信公众平台服务号才有的。
对外开放的通用接口设计
qq_33045443的博客
04-20 6211
需求：以自己当前的系统作为一个平台，提供一下接口对外开放。其他接入我们对外开放的平台或系统则统称为第三方平台。 如果想要提供一套统一的接口，即可对接各种各样的第三方平台的话，就需要将对外的接口做成通用接口。 由于各平台的差异性，平台A：酒店系统的，平台B：商城系统的，平台C：某物品零售系统的。 由此可见第三方的不同系统的订单表字段以及字段的意义都是千差万别的。 那...
如何设计一个安全的对外接口
公众号：Java后端
11-26 342
优质文章，及时送达作者 |ksfzhaohui来源 | my.oschina.net/OutOfMemory/blog/3131916前言最近有个项目需要对外提供一个接口，提供公网域名进行访问，而且接口和交易订单有关，所以安全性很重要；这里整理了一下常用的一些安全措施以及具体如何去实现。阅读更多关于 Spring Boot、Java 、Spring全家桶 等技术文章，欢迎关注微信公众号：Java...
外部api接口调用封装
fsdf8sad7的博客
06-09 1859
简述：一般我们调用外部系统 比如使用httpclilent.post(url,param)； 然后我们会在各种地方使用httpclilent.post(url1,param1)、httpclilent.post(url2,param2)； 比较好的办法如下，直接上代码。下面是一个简单的基本封装模型。 /** * 请求参数基类 */ public abstract class BaseReq<resp> { protected String reqUrl; publ
如何做一个简单的开放接口（1）-功能设计
刘海龙的专栏
05-17 1万+
第一篇，包括：缘起、技术需求、功能规划、功能设计。
怎么开发一个完整的对外接口API
热门推荐
douxingpeng1的博客
08-15 4万+
1、客户端请求加密、服务端请求解密 2、防止重复提交 一般是在数据库加状态，在 status=0 的状态下更新，更新完状态变为1，这样就可以防止重复提交 --------------------------------------------------------------------------------- 签名基本原理是通过 key/secret 的实现： 1, 服务器......
spring boot统一对外开放接口设计
09-10
对于Spring Boot统一对外开放接口的设计，以下是一些常见的做法和建议： 1. 使用RESTful风格：采用符合RESTful规范的URL设计，使用HTTP动词来表示对资源的操作，如GET、POST、PUT、DELETE等，使接口易于理解和使用...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值