设计系统API的原则

18、API开发与文档:从基础到REST设计原则 本文介绍了API开发的基础知识以及如何遵循REST设计原则来构建高效、可扩展的API系统。内容涵盖端点和有效负载的设计、HTTP请求与响应的结构、常见的HTTP状态码,以及REST架构的核心原则,如客户端-服务器分离、无状态性、缓存、统一接口、分层系统和代码按需。通过这些概念和实践示例,读者可以全面了解如何设计规范且灵活的API服务。 阅读详情

测试的时候发现同事的代码有一个BUG:一个返回分组查询SQL文select子句的方法,其中一个参数如果为NULL的话,返回的select子句有语法错误。向同事提出,并建议增加一段代码,对NULL值做特别处理。

可同事不同意,理由是:如果按我说的修改,再配合其它方法做成的where子句、orderBy子句,SQL文前后的逻辑也会出问题。

他的理由很好反驳:SQL文可以没有where子句和orderBy子句,但select不能有语法错误。

经过讨论,最后我的方法得到了头儿的支持。

 

不过发现好像大家对API的开发还没有特别深刻的认识,一些原则并不明确,包括我自己。

所以在这里做一点总结,以后有章可循,不迷惑:

 

1、 类、方法,必须是各自独立的。多个类或方法配合使用才正确的想法是绝对错误的。这也是耦合性和内聚性的基本要求。

2、 独立运行一个方法,返回值或运行结果必须是正确的可用的。例如上面的例子,每一个做SQL文的方法返回的语句都应该是正确没有语法错误的。对每一个参数,只要是允许输入的值都应该返回正确的结果;不允许输入的值要抛异常。

3、 代码注释和异常消息信息要准确,描述要全面,语言要简洁。

 

    (先总结这几条,以后想到什么再追加。 to be continue......)

我在架构设计和代码开发中的一些常用原则 不管我一生中取得了多大的成功,其主要原因都不是我知道多少事情,而是我知道在无知的情况下自己应该怎么做。我一生中学到的最重要的东西是一种以原则为基础的生活方式,是它帮助我发现真相是什么,并据此如何行动。 ——瑞·达利欧(Ray Dalio) 在日常的开发和设计过程中,大家对技术设计上的一些问题往往会面临很多的选择,不同的人会有不同的选择,每每如此,我都会尝试着问自己:我做出选择和判断背后的原则是什么?经过这么多年的发展,在软件设计过程,目前沉淀下来的原则有很多,但很多情况下,很多原则为了普适性,总结得. 阅读详情

相关推荐

电磁仿真软件CST2020 下载链接及安装破·解教程笔记

众所周知,配环境是安装软件最头疼的事情。CST2020我调了一上午,网上现有的安装教程良莠不齐,很难有一篇文章能够全流程的讲述安装过程以及遇到的问题。正好今天我要给另一台电脑装软件,借此机会把安装过程记录下来,以供将来使用和他人借鉴。 首先提供下载地址: 百度网盘 链接:https://pan.baidu.com/s/1cDJZelufj-nliUfekMNpEA 提取码:8ihx 附: 根据二○○二年一月一日《计算机软件保护条例》规定:为了学习和研究软件内含的设计思想和原理,通过安装、显示、传输或者存储软

weixin_42845306的博客 3万+

Restful API 设计原则

Restful API 设计原则 前言 网络应用程序分为前端和后端两个部分。 当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备……),这也就意味着前端的开发代码、开发框架变得多种多样。因此,必须有一种统一的机制,方便不同的前端代码与后端进行通信。 这就导致了API构架的流行。REST是目前比较成熟的一套互联网应用程序的API设计理论。 它可以降低开发的复杂度,提...

Mr.Phoebe的专栏 7666

ArcGIS License Server点击启动没反应,许可管理器无法启动怎么办

4 当我们再打开ArcGIS License Server Administrator的时候。3 在【服务】中找到【ArcGIS License Manager】双击。无法启动ArcGIS License Server的情况。在使用ArcGIS的过程中,我们经常会遇到。专注GIS领域知识分享,交流行业软件技巧。欢迎关注,不定期分享GIS各种问题和技巧。1 右击我的电脑——【管理】服务状态——启动,确定即可。启动类型选择——自动。

GIS蒲公英的博客 2万+

软件系统架构黄金法则:高效的API设计原则

1.背景介绍 软件系统架构黄金法则:高效的API设计原则 作者:禅与计算机程序设计艺术 1. 背景介绍 1.1 API的定义和意义 API(Application Programming Interface),中文名称应用程序编程接口,是一组用于开发和集成软件系统的规范、协议和工具。API允许不同的应用程序之间共享数据和功能,从而提高软件系统的可扩展性、可重用性和可维护性。API的设计质...

AI天才研究院 1323

C51红外接收与发射控制及原理编码与解码

基于38khz的NEC协议红外发射简易电路图NEC协议产生红外光数据编码 0 1结合程序红外接收接收电路解码过程解码代码 红外发射 通过通过红外二极管发射红外光,三极管的状态来控制。 红外模块一般都是三个引脚,vcc,gnd,dat,通过控制dat口的来控制发射红外光。 简易电路图 将数据口连接到单片机的引脚为上,控制io口的电平状态,来控制三极管的导通状态,从而发射红外光。 NEC协议 NEC协议特点:8位地址和8位命令为提高可靠性,地址和命令都传输2次,脉冲间隔调制38kHz载波频率。 包含引导码,

yangfeng20的博客 1万+

Cocos Creator3.5.2使用Spine切换皮肤

3、然后获取当前spine中是否有皮肤数据,如果spine连皮肤数据都没有,接着写可能会error,这里的 skins[skin],是判断皮肤列表中是否有需要更换的皮肤。2、因为spine往往意味着异步加载,换肤时也经常出现频繁异步的情况,所以下一步我们要可以判断当前spine组件里是否已经加载好了spine文件。换肤前隐藏好需要换肤的节点,避免穿帮;官网文档的换肤流程太简化,对于实际使用来说会有各种各样的问题。1、首先获取对应的spine组件。这里的skin自然是外部传入的需要换肤的皮肤名。

tc654321的博客 1822

知识总结·多系统数据同步API调用设计原则

阅文时长 | 0.12分钟 字数统计 | 207.2字符 主要内容 | 1、引言&背景 2、声明与参考资料 『知识总结·多系统数据同步API调用设计原则』 编写人 | SCscHero 编写时间 | 2021/7/28 PM2:3 文章类型 | 系列 完成度 | 已完成 座右铭 每一个伟大的事业,都有一个微不足道的开始。 一、引言&背景   完成度:100% a) 问题由来 最近需要做多系统..

SCscHero的博客 620

深入GD32/STM32引脚复用:你的JTAG/SWD接口是怎么‘消失’的?一次讲清原理与预防

本文深入解析GD32/STM32调试接口(JTAG/SWD)突然失效的原理与预防措施。通过分析MCU启动流程、引脚复用机制及典型错误代码模式,揭示调试接口'消失'的根本原因,并提供硬件设计检查清单、软件防护代码及开发流程优化方案,帮助开发者有效避免烧录失败问题。

weixin_42532938的博客 370

如何掌握底层API设计原则:成为系统编程专家的10个关键技巧

Lowlevelprogramming-university 是一个专门为想要成为底层程序员的开发者设计的完整学习路线图。这个项目提供了从硬件设计到Linux内核开发的全面指南,帮助开发者掌握底层API设计的核心原则,成为真正的系统编程专家。底层API设计是连接硬件与软件的关键桥梁,它决定了系统的性能、稳定性和可扩展性。 ## 为什么底层API设计如此重要?🔍 底层API设计直接关系到系统的

gitblog_00073的博客 966

【DRAM存储器六十一】LPDDR5介绍--LPDDR5/5X/4/4X IO结构

简述LPDDR5/5X/4/4X IO结构及等效电路下的VREF理论值计算

highman110的博客 484

Claude Code 新手安装指南,手把手教你怎么安装使用

如果你是企业内网用户,或者需要自定义 API 端点,那可以用手动配置 API Key 的方式。

篮球界最会写bug的人;程序猿中打球最菜的人。 498

Ferry工单系统RESTful API设计指南:10个核心原则与最佳实践

Ferry工单系统是一款集工单统计、任务钩子、权限管理、灵活配置流程与模版等于一身的开源工单系统,也可称为工作流引擎。本文将详细介绍Ferry工单系统RESTful API设计的10个核心原则与最佳实践,帮助开发者构建高效、可靠的API接口。 ## 一、资源命名规范 在Ferry工单系统中,API资源命名应遵循清晰、一致的原则。例如,工单相关的API路径使用`/workOrder`,任务相关的使

gitblog_00416的博客 492

【知识图谱】Neo4j基本操作及数据库文件导入(graph.db.dump)

初探Neo4j导入数据备份数据客户端操作导入csv文件指定csv文件格式使用命令行导入csv文件附录 请读者参考上篇博文 Neo4j安装教程 导入数据 若开启服务,先在终端停止 Neo4j 服务 ./neo4j stop 接下来,下载射雕三部曲的数据库文件 wget https://labfile.oss.aliyuncs.com/courses/1354/graph.db.dump 下载完将出现 graph.db.dump 文件: 将数据库文件导入到 Neo4j 中 首先进入neo4j 根目录下:

全网粉丝30W+,优快云、稀土掘金人工智能领域签约作者,人工智能、大模型、Python 爬虫,商务合作,请私信沟通。 8621

实时嵌入式系统API与HAL设计:从核心原则到工程实践

在嵌入式系统开发中,硬件抽象层(HAL)和应用程序接口(API)是连接底层硬件与上层应用的关键桥梁。其核心原理在于通过标准化接口封装硬件差异,实现代码的可移植性和可维护性。从技术价值看,良好的HAL/API设计能显著提升开发效率、保障系统实时性,并便于团队协作。在实时嵌入式系统这一典型应用场景中,设计需特别关注确定性、中断安全性和与RTOS的协同。本文聚焦于如何为实时嵌入式系统构建一套稳健的API与HAL,深入探讨了以实时性为首要约束的设计原则,并详细解析了在集成DMA和中断(如实现串口空闲中断加DMA接收

weixin_30664615的博客 329

贝叶斯统计 [韦来生编]

贝叶斯(Bayes)统计是近几十年来迅速发展起来的数理统计的一个重要分支。贝叶斯方法与经典统计方法的主要不同之处是进行统计推断时除了利用样本信息外,还要利用参数的先验信息,因此可以提高统计推断或统计决策的效果。它在经济、金融、生物、医学、自然科学和社会科学等许多领域具有广泛的应用。贝叶斯方法的研究已渗透到了统计学的几乎所有领域。作者在给中国科学技术大学概率论与数理统计专业本科生开设的“数理统计”课程中有一章专门讲授“贝叶斯方法和统计决策理论”,近十年来也给中国科学技术大学概率统计专业研究生开设过几次“贝叶斯分析”课。本书是在对过去讲稿的内容作了适当的增减和调整的基础上完成的。  本书共分六章。第1章是绪论,介绍了贝叶斯统计的若干基本概念,同时对必要的数理统计的基础知识有重点地作了回顾。第二章介绍了确定先验分布的若干可供选择的方法。第三章介绍了几类常见统计模型参数的后验分布的主要结果和计算方法。第四章和第五章分别介绍了“贝叶斯统计推断”和“贝叶斯统计决策”的内容。第六章介绍了贝叶斯统计计算的若干方法,包括蒙特卡洛方法和马尔可夫链蒙特卡洛(MCMC)方法以及相关统计软件的简介。本书的每一章附右大量的例题和习题,书末附有常用的几个表格和部分习题解答供读者查用。  大约可在54学时内讲授本书的第1章至第六章的主要内容,教师可根据学时需要选讲本书第1章至第六章的部分内容。书中标“*”号的章节可略去不讲,留给读者作为阅读材料。第六章例题中的R代码和部分例题的数据文件等可从作者个人主页下载。  作者在编写本书的过程中参考了J.O.Berger教授的《统计决策论及贝叶斯分析》和茆诗松教授编写的《贝叶斯统计》等书中的一些内容,以及《贝叶斯分析》一书中由张伟平博士编写的有关贝叶斯统计计算的一些内容。在此表示衷心感谢。  本书编写准备过程中,中国科学技术大学统计与金融系的几个研究生帮助完成了本书部分中文的录入和排版,作者对他们的辛勤工作表示真诚的感谢。高等教育出版社为本书的出版给予了大力支持。在此一并致谢。

NTscan扫描工具

ntscan是一个扫描器,可以扫描没有密码和弱密码的共享,先到配置文件中填写猜测的用户名和密码,扫描过程中右侧出现的是扫描日志。

API设计终极指南:鲁棒性原则如何保障系统兼容性

在软件开发中,API(应用程序编程接口)作为系统间通信的桥梁,其设计质量直接影响系统的稳定性与扩展性。**鲁棒性原则**(Robustness Principle)作为API设计的黄金法则,通过"严于律己,宽以待人"的核心思想,帮助开发者构建兼容各种场景的接口。本文将深入解析鲁棒性原则的实践方法,结合真实案例与可视化图表,为新手开发者提供一套可落地的API设计指南。 ## 为什么鲁棒性原则是AP

gitblog_00758的博客 465

Probability and Statistics - 4th edition

Probability and Statistics - 4th edition

实时嵌入式系统API与HAL设计:从确定性原则到RTOS协同实战

在嵌入式系统开发中,硬件抽象层(HAL)和应用程序接口(API)是连接硬件与软件的关键桥梁,其设计质量直接影响系统的实时性、可维护性和可移植性。HAL的核心原理在于抽象硬件差异,提供统一的硬件操作接口,而API则在此基础上构建面向应用的语义化功能模块。从技术价值看,优秀的分层设计能显著降低硬件依赖,提升代码复用率,并确保实时系统的确定性响应。尤其在实时操作系统(如FreeRTOS)环境中,HAL需要严格遵循“确定性优先”原则,避免动态内存分配、阻塞调用等非确定性操作,并通过回调机制、资源外置等工程实践保障实

weixin_30512089的博客 519

C# WinForm 基于DirectShow.dll编写的程序,可边预览边保存视频,音频和图片

基于微软的DirectShow.dll的二次开发1.自动识别连接的摄像头跟麦克风且可以对其进行选择(默认选中第一个)2.可录制wmv和avi两种格式的视频并且都带有音频,avi可以录制的分辨率和帧数进行选择,wmv默认进行了淸晰度优化如不喜欢可去除代码中有相关提示3.可在预览点开之后进行拍照,也可边录制视频边拍照4.添加了视频和音频的压缩功能(酌情使用)这次二次开发发现C#对DirectShow的相关信息太少,这次做完也不敢藏私共享出来,还望大家指正

【系统级性能突破】:零拷贝API设计的5大核心原则

突破系统性能瓶颈,掌握零拷贝的 API 设计核心方法。适用于高并发、低延迟场景,通过内存映射、避免数据复制、减少上下文切换等技术提升效率。详解5大设计原则与实际应用,显著降低CPU开销与延迟,值得收藏。

CodeVibe的博客 1019

API接口设计原则与应用实践

API接口设计原则与实践摘要 本文介绍了基于SOLID原则的API接口设计最佳实践。SOLID原则包含:单一职责原则(SRP)强调接口功能单一化;开闭原则(OCP)提倡通过扩展而非修改实现新功能;里氏替换原则(LSP)要求子类可完全替代父类;接口隔离原则(ISP)避免客户端依赖不需要的方法;依赖反转原则(DIP)主张高层与底层模块共同依赖抽象。文章通过具体代码示例展示了如何应用这些原则,如支付接口的设计、打印机接口的拆分等,帮助开发者构建高内聚、低耦合的系统架构,提升代码的可维护性和扩展性。

一名80后IT人的成长记录,记录自己在工作、学习中的点点滴滴,在成长的喜悦与忧心的故事里,铭记反脆弱的勇气。 1224

AI Agent从无到有54:工具设计原则与多系统集成实践(搜索/知识库/钉钉API)

这篇文章介绍了如何为智能体(如钉钉智能客服)设计和实现工具集,使其具备执行特定任务的能力。主要内容包括: 工具设计原则:强调最小颗粒度、结构化输入和清晰功能描述三个核心原则。 工具集组成: 在线搜索工具(web_search):使用SerpAPI获取实时信息 知识库检索工具(search_knowledge_base):基于Chroma向量数据库 钉钉待办工具(create_todo):创建待办事项 钉钉日历工具(manage_calendar):提供日程增删查改功能 技术实现: 使用Pydantic模型确

Wang的专栏 782

从零构建高可用AI系统:Python多模型API调度设计的3大核心原则

掌握高可用AI系统构建秘诀,详解Python多模型API融合调用的三大设计原则。适用于微服务架构与AI中台场景,通过负载均衡、容错机制与动态调度提升系统稳定性与响应效率。架构师与开发者值得收藏的实战指南,点击了解实现细节。

InstrWander的博客 466

Python RESTful API 设计的基本原则与实现方案

通过遵循 RESTful API 的设计原则,并结合 Python 的强大功能,我们可以轻松地构建出高效、可靠的 API 服务。Flask 提供了足够的灵活性,使得开发者可以根据具体需求进行定制化开发。希望本文能够帮助你更好地理解和实践 Python 中的 RESTful API 设计。```

2501_90689142的博客 593

关于系统设计原则回顾

     最近有人问我 系统设计的原则,事实上不论今天各个技术栈怎么演化,那些本质的原则与方法不会变, 让我们回顾一下 这些原则:•分散关注 Separation of concerns. Divide your application into distinct features with as little overlap in functionality as possible. The i...

weixin_33801856的博客 313

K8S中API设计原则和控制机制设计原则

API设计原则 对于云计算系统,系统API实际上处于系统设计的统领地位,正如本文前面所说,K8s集群系统每支持一项新功能,引入一项新技术,一定会新引入对应的API对象,支持对该功能的管理操作,理解掌握的API,就好比抓住了K8s系统的牛鼻子。K8s系统API的设计有以下几条原则: 所有API应该是声明式的。正如前文所说,声明式的操作,相对于命令式操作,对于重复操作的效果是稳定的,这对于容易出现数据丢失或重复的分布式环境来说是很重要的。另外,声明式操作更容易被用户使用,可以使系...

c1052981766的专栏 418

API设计的几条原则

API 本身的含义指应用程序接口,包括所依赖的库、平台、操作系统提供的能力都可以叫做 API。我们在讨论微服务场景下的 API 设计都是指 WEB API,一般的实现有 RESTful、RPC等。API 代表了一个微服务实例对外提供的能力,因此 API 的传输格式(XML、JSON)对我们在设计 API 时的影响并不大。 API 设计是微服务设计中非常重要的环节,代表服务之间交互的方式,会影响服务之间的集成。 通常来说,一个好的 API 设计需要满足两个主要的目的: 平台独立性。 任何客户端都能消费 API

yonhu123java的博客 892

路由系统解析高级URL模式参数提取与RESTful API设计原则(1750485963822500)

Hyperlane is a lightweight and high-performance Rust HTTP server library designed to simplify network service development. It supports HTTP request parsing, response building, TCP communication, and redirection features, making it ideal for building modern

m0_52796585的博客 420
上一篇: Winxp中Msdtc服务无法启动的解决方法
httpftp
博客等级 码龄21年 20粉丝 6原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明:

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

余额充值