1. 接口设计1.1 RESTful APIRESTful API(Representational State Transfer Application Programming Interface)是一种基于REST架构风格的API设计理念,它是一种通过网络进行通信的接口设计规范。RESTful API的核心思想是将资源抽象为URI(Uniform Resource Identifier),使用
转载
2024-02-28 17:44:23
48阅读
只要你在写Java代码你就是一个API接口的设计者!程序员分不分享他们的代码不重要,代码会一直被其他人或代码的作者使用。因此,Java开发者掌握优秀API设计的基本理念就很重要了。一个好的API设计需要严谨的思维和很多经验之谈。幸运的是,我们可以向其他聪明的人学习,比如Ference Mihaly,他的指南鼓励我写下这篇Java 8 API补充的文章。笔者在设计 Speedment API的时候,
转载
2024-01-02 14:03:43
36阅读
Java 8的API设计原则掌握的Java API 8设计,才能确保客户端代码可以使用lambda表达式访问API。 一个好的API的设计需要仔细思考和大量的经验。因为一旦一个API公布,从一开始就贯彻坚定的承诺是非常重要。公共API,就像钻石,永远留传。 你只有一次得到它的机会,所以给她最好的。API结合平衡了两个世界:坚定的和精确的承诺;以及具有高度的灵活性。下面是清单:如果一个值缺
转载
2024-01-27 19:58:22
161阅读
在设计Java API的时候总是有很多不同的规范和考量。与任何复杂的事物一样,这项工作往往就是在考验我们思考的缜密程度。就像飞行员起飞前的检查清单,这张清单将帮助软件设计者在设计Java API的过程中回忆起那些明确的或者不明确的规范。本文也可以看作为“API设计指南”这篇文章的附录。我们还准备了一些前后比对的例子来展示这个列表如何帮助你理清设计需求,找出错误,识别糟糕的设计实践以及如何寻找改进的
转载
2023-10-31 15:33:35
60阅读
很多API安全问题产生的根源是缺少好的API安全设计,做好API安全设计有利于提升API自身的安全性。这里讲2条设计原则:5A原则和纵深防御原则。一、5A原则5A原则由5个首字母为A的单词构成:Authentication(身份认证)、Authorization(授权)、Access Control(访问控制)、Auditable(可审计性)和Asset Protection(资产保护)。在做安全
转载
2024-03-09 20:38:35
45阅读
## Java API 设计模式
### 简介
在软件开发中,设计模式是一种被广泛使用的解决问题的方法论。设计模式可以提供一种通用的解决方案,帮助开发人员提高代码的可复用性、可维护性和可扩展性。Java API 设计模式是一套特定于 Java 编程语言的设计模式,用于解决 Java 开发中常见的问题。
在本文中,我们将介绍 Java API 设计模式的流程,并提供每个步骤所需的代码示例和解释。
原创
2023-09-17 09:19:15
32阅读
译者:highkay@东西
来源:://blog.jobbole./12958/
在设计Java API的时候总是有很多不同的规范和考量。与任何复杂的事物一样,这项工作往往就是在考验我们思考的缜密程度。就像飞行员起飞前的检查清单,这张清单将帮助软件设计者在设计Java API的过程中回忆起那些明确的或者不明确的规范。本文也可以看作为“API设计指南”这篇文章的附录。
我们还准备了
转载
2019-12-27 17:40:00
95阅读
2评论
在设计Java API的时候总是有很多不同的规范和考量。与任何复杂的事物一样,这项工作往往就是在考验我们思考的缜密程度。就像飞行员起飞前的检查清单,这张清单将帮助软件设计者在设计Java API的过程中回忆起那些明确的或者不明确的规范。本文也可以看作为“API设计指南”这篇文章的附录。我们还准备了一些前后比对的例子来展示这个列表如何帮助你理清设计需求,找出错误,识别糟糕的设计实践以及如何寻
原创
2022-11-25 16:22:02
104阅读
在设计Java API的时候总是有很多不同的规范和考量。与任何复杂的事物一样,这项工作往往就是在考验我们思考的缜
原创
2023-04-27 22:02:44
62阅读
# 如何设计Open API使用Java
在当今的开发环境中,开放API(Open API)越来越重要。设计一个开放API让各种应用能互通信息,极大地提高了系统的灵活性和可扩展性。本文将以Java为例,带领你从零开始创建一个Open API。
## 流程概述
以下是创建开放API的基本步骤,概述在下面的表格中:
| 步骤 | 描述
原创
2024-10-27 03:34:49
65阅读
一、什么是设计模式? 设计模式(Design pattern)是一套被反复使用、多数人知晓的、经过分类编目的、代码设计经验的总结。使用设计模式是为了可重用代码、让代码更容易被他人理解、保证代码可靠性。 毫无疑问,设计模式于己于他人于系统都是多赢的,设计模式使代码编制真正工程化,设计模式是软件工程的基石,
转载
2023-07-21 16:54:06
118阅读
作者:Alan_beijing在设计接口时,有很多因素要考虑,如接口的业务定位,接口的安全性,接口的可扩展性、接口的稳定性、接口的跨域性、接口的协议规则、接口的路径规则、接口单一原则、接口过滤和接口组合等诸多因素,本篇文章将简要分析这些因素。一、规范性建议1、职责原则在设计接口时,必须明确接口的职责,即接口类型,接口应解决什么业务问题等。2、单一性原则在明确接口职责的条件下,尽量做到接口单一,即一
转载
2024-04-24 22:15:15
53阅读
在JDK 1.4以前,Java的IO操作集中在java.io这个包中,是基于流的阻塞(blocking)API。对于大多数应用来说,这样的API使用很方便,然而,一些对性能要求较高的应用,尤其是服务端应用,往往需要一个更为有效的方式来处理IO。从JDK 1.4起,NIO API作为一个基于缓冲区,并能提供非阻塞(non-blocking)IO操作的API被引入。本文对其进行深入的介绍。NIO AP
转载
2024-08-20 11:02:17
29阅读
在Web API接口的开发过程中,我们可能会碰到各种各样的问题,我在前面两篇随笔《Web API应用架构在Winform混合框架中的应用(1)》、《Web API应用架构在Winform混合框架中的应用(2)--自定义异常结果的处理》也进行了总的介绍,在经过我的大量模块实践并成功运行后,总结了这篇随笔,希望对大家有所帮助。1、在接口定义中确定MVC的GET或者POST方式由于我们整个Web API
转载
2023-07-19 16:26:56
137阅读
译者: 王磊 前言 市场上关于如何设计和编写优秀Java代码的书如此之多,可能要用汗牛充椟来形容,但是想找到一本如何设计API的书,却是难之又难。这里我将把自己一些关于API设计的经验与大家分享。 分享这些经验是源于最近我参加了JavaPolis上的一个讨论,这个讨论是由Elliotte Rusty Harold发起的,是关于设计XOM时的一些原则性问题,讨论中的思想交流如此精采,令我受益
转载
2024-01-24 16:48:58
46阅读
Java API设计指南(一)接口的功能被夸大了: 在Java的世界,有一些API的设计原则是很通用的,如尽量使用接口的方式来表达所有的API(不要使用类来描述API)。接口自有它的价 值,但是将所有的API都通过接口来表示并不见得总是一个好的设计方案。在使用一个接口来描述API时,必须有一个足够的理由。下面给出了一些理由: 1、接口可以被任何人所实现。假设String是一个接口而非类,永
转载
2023-08-29 23:17:14
113阅读
1. 基础说明1.1 背景[说明文档用途]编写本文的目的是为了将系统功能进行模块化、服务化,将用户的操作以服务的方式提供。系统与系统之间遵循服务规范,将系统与系统之间的交互转为定制化服务交互,以实现系统与系统之间的集成。1.2 基本约束1.2.1 基本设计原则 1.2.2 字符集所有接口字符集采用UTF-8。1.2.3 返回类型约束所有接口返回必须是严格定义的JSON类型。1
转载
2023-09-11 22:01:34
125阅读
前言在实际工作中,我们需要经常跟第三方平台打交道,可能会对接第三方平台API接口,或者提供API接口给第三方平台调用。那么问题来了,如果设计一个优雅的API接口,能够满足:安全性、可重复调用、稳定性、好定位问题等多方面需求?今天跟大家一起聊聊设计API接口时,需要注意的一些地方,希望对你会有所帮助。1. 签名为了防止API接口中的数据被篡改,很多时候我们需要对API接口做签名。接口请求方将请求参数
转载
2023-07-26 23:11:35
21阅读
一、需求背景java后端需要提供接口服务,其中接口服务分为对内网的后台管理系统的接口,对外网的用户接口和对第三方系统的接口。这里主要讲对第三方的接口。二、接口设计我们可以参考微信小程序的接口,一般一个系统提供给第三方系统的接口都需要接口权限认证,也就是先获取token,然后通过token再进行接口数据请求。这是为了保障数据的安全性。这是第三方接口设计的基本规范。 其中toke
转载
2023-07-19 00:31:20
187阅读
使你的API在模块化和非模块化Java环境中都可用在优锐课的java学习分享中,对微服务有了更深层次的新概念。关于API设计实践一点就通了。介绍了解设计Java API时应应用的一些API设计实践。通常,这些做法很有用,可确保在OSGi和Java平台模块系统(JPMS)等模块化环境中可以正确使用API。有些做法是规定性的,有些是规定性的。当然,其他良好的API设计规范也适用。OSGi环境使用Jav
转载
2023-08-31 19:07:09
94阅读