前言在实际工作中，我们需要经常跟第三方平台打交道，可能会对接第三方平台API接口，或者提供API接口给第三方平台调用。那么问题来了，如果设计一个优雅的API接口，能够满足：安全性、可重复调用、稳定性、好定位问题等多方面需求？今天跟大家一起聊聊设计API接口时，需要注意的一些地方，希望对你会有所帮助。1. 签名为了防止API接口中的数据被篡改，很多时候我们需要对API接口做签名。接口请求方将请求参数
转载
2023-07-26 23:11:35
0阅读
1. 基础说明1.1 背景[说明文档用途]编写本文的目的是为了将系统功能进行模块化、服务化，将用户的操作以服务的方式提供。系统与系统之间遵循服务规范，将系统与系统之间的交互转为定制化服务交互，以实现系统与系统之间的集成。1.2 基本约束1.2.1 基本设计原则 1.2.2 字符集所有接口字符集采用UTF-8。1.2.3 返回类型约束所有接口返回必须是严格定义的JSON类型。1
转载
2023-09-11 22:01:34
83阅读
本文的内容基本来自How To Design a (module) API，下面是我对里面涉及代码的一个实现。
1：Allow access only from a friend code
SPI:Service Provider Interface
API 和SPI的区别：
In case of an API that is offering methods to
原创
2009-04-13 00:57:43
685阅读
1评论
1. 接口设计1.1 RESTful APIRESTful API（Representational State Transfer Application Programming Interface）是一种基于REST架构风格的API设计理念，它是一种通过网络进行通信的接口设计规范。RESTful API的核心思想是将资源抽象为URI（Uniform Resource Identifier），使用
小结： 1、 https://mp.weixin.qq.com/s/qWrSyzJ54YEw8sLCxAEKlA API 设计最佳实践的思考 谷朴 阿里技术 昨天 阿里妹导读：API 是模块或者子系统之间交互的接口定义。好的系统架构离不开好的 API 设计，而一个设计不够完善的 API 则注定会导致
转载
2019-05-10 20:22:00
359阅读
2评论
前段时间组织优化我们的原生模块 API（iOS、Android 模块封装成 JavaScript 接口），于是学习了几篇 JavaScript API 设计的文章，尽管是旧文，但受益匪浅，这里记录一下。好的 API 设计：在自描述的同时，达到抽象的目标。设计良好的 API ，开发者可以快速上手，没必要经常抱着手册和文档，也没必要频繁光顾技术支持社区。流畅的接口流畅易读，更易理解// 常见的 API
转载
2024-01-18 11:09:27
48阅读
id=8，序号 = 3，每次有新增、删除，就要重新生成集合，很不好维护。还有一个问题，感觉就是有点耦合，的，
原创
2023-08-01 10:11:24
56阅读
很多API安全问题产生的根源是缺少好的API安全设计，做好API安全设计有利于提升API自身的安全性。这里讲2条设计原则：5A原则和纵深防御原则。一、5A原则5A原则由5个首字母为A的单词构成：Authentication（身份认证）、Authorization（授权）、Access Control（访问控制）、Auditable（可审计性）和Asset Protection（资产保护）。在做安全
目前互联网上充斥着大量的关于RESTful API（为方便，下文中“RESTful API ”简写为“API”）如何设计的文
原创
2023-07-31 10:24:58
74阅读
本文中我们将会为 Kuebernetes 构建一个完备的单点登录系统，这个系统会为 kubectl、Web 应用的 Ingress，以及 Docker 镜像仓库和 Gitea 提供服务，本文中会涉及多数单点登录模型，对于 Gitlab、Kibana、Grafana 等其它应用，应该也是适用的。整个方案中使用了以 OpenLDAP 为后端的 KeyCloak 服务。OpenLDAP 能满足 Gite
Web API 设计
The Design of Web APIs
转载
2020-11-05 19:50:00
106阅读
2评论
在项目中，需要为APP撰写API。刚开始接触的时候，并没有考虑太多，就想提供URL，A
转载
2021-07-13 13:46:36
397阅读
为什么需要了解一些API设计？ 只要你编程，你就是API Designer 一个好的设计，模块之间的耦合应该也是API级别的 一个程序，如果你独立开发，那你既是API的Designer，也是API的User 如果你和你的同事一起开发，，你既是你开发的模块API的Designer，也是其他同事模块API的User 一个好的API应该具备哪些特点？ 1. 易学易用（Easy to learn and use） 要做到易学易用，需要满足以下基本要求： a. API命名的要适应用户的习惯并遵循一些模式。例如：使用类似于add/delete, get/set，push_bach/pop_back这种大.
转载
2013-09-17 22:24:00
202阅读
摘要：目前互联网上充斥着大量的关于RESTful API（为了方便，以后API和RESTful API 一个意思）如何设计的文章，然而却没有一个”万能“的设计标准：如何鉴权？API格式如何？你的API是否应该加入版本信息？
RESTful API 设计指南，RESTful API 设计最佳实践
网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他
转载
2021-08-20 11:29:46
515阅读
API，它的全称是Application Programming Interface——应用程序编程接口，是一组指令、标准或要求，使软件或应用程序可以利用另一应用程序、平台或设备的功能/服务来获得更好的服务。简而言之，它可以让应用程序彼此通信。例如，当我们要获取淘宝参数时，都会通过API请求后台服务器上的数据，获取数据 文档：为API编写文档，可以使用OpenAPI的规范的格式，这样其他
转载
2024-01-21 10:08:04
68阅读
前言 对于前后端分离的项目，主要是以API为界限进行解耦，那么在web开发中，对于api的设计能够遵循REST设计原则，即可以称为Restful api。使用Restful设计api主要有两点好处，一是表现力更强，更易于理解；二是Restful为无状态的，不管前端是何种设备何种状态都能够无差别的请求资源。构建步骤一：基于业务领域的数据建模，而不是基于功能建模 基于功能建模时，会造成api臃肿并且
最近在做API的权限设计这一块，做一次权限设计的总结。1. 假设我们需要访问的API接口是这样的：http://xxxx.com/openapi/v1/get/user/?key=xxxxx&sign=sadasdas×tamp=2013-03-05 10:14:00&c=c&a=a&d=d 2. 接口调用的控制器：openapi/v1/
转载
2023-07-23 22:44:02
76阅读
网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理解RESTful架构》，探讨如何理解这个概念。
网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理解RESTful架构》，探讨如何理解这个概念。今天，我
RESTful API 设计指南
网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。 因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理
