API设计

于 2024-05-21 15:50:54 发布
阅读量131 收藏
点赞数 3
分类专栏： 想法 文章标签： 设计
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_37962554/article/details/139089414
版权

API设计尽量保证职责单一

一个API只做一件事情

API不应该基于实现去设计

在API层面不应该暴露实现细节，从而误导用户

避免标志性质的参数


接口不要为了兼容不同的逻辑分支，增加参数让调用方去抉择。类似单一职责。

API设计出入参需要保证风格一致

ELI_He999
关注
  • 3
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
RESTful API设计实例
weixin_58029845的博客
11-03 1922
前几期笔者介绍了RESTful API设计基础知识、定义及管理指南和设计规范，本篇将着眼于RESTful API设计实例，从基本架构、模拟实例、代码与RESTful API几个方面进行阐述，希望对大家理解REST相关内容有所帮助。
API设计教程
03-23
大多数人的经验都源于不断犯错或借鉴别人的经验，而本书试图打破这种局面，提炼出耐用且不会过时的API设计策略。API有哪些品质要求，有哪些关键要素，有哪些通用的技巧，设计时要遵循哪些原则……这些问题都能在本书...
C++ API设计笔记
网络资源是无限的
03-29 7048
《C++ API设计》原英文版由Martin Reddy著，中文版出版于2013年，这里是中文版的笔记。 1. API简介 1.1 什么是API：API(Application Programming Interface)提供了对某个问题的抽象，以及客户与解决该问题的软件组件之间进行交互的方式。组件本身通常以软件类库形式分发，它们可以在多个应用程序中使用。概况地说，API定义了一些可复用的模块...
API设计规范
小末的博客
02-27 4184
1 端点规范 API端点就是API的URI，例如：https://api.example.com/users/me 优秀的端点设计的重要原则： 容易记忆，URI包含的功能一目了然。 1.1端点的基本设计规范 短小便于输入 人可以读懂 没有大小写混用 方便修改 不会暴露服务架构 规则统一 1.2 HTTP方法和端点 端点和HTTP可以被认定是操作对象和操作方法的关系。 URI...
API设计指南整理
发现问题，面对问题，分析问题，解决问题，总结问题
05-20 2123
Google REST API（也被称为REST方法）的标准方法有List，Get，Create，Update和Delete。API的设计者也可以用自定义方法（也被称为自定义动词或者自定义操作），来完成那些不易对应到标准方法的功能，比如数据库事务。
Google Cloud API设计指南
程序猿CKeen的专栏
12-29 2627
一、基于资源的设计 本设计指南的目标是帮助开发者设计简单、一致且易用的网络 API。同时，它还有助于将 RPC API（基于套接字）与 REST API（基于 HTTP）的设计融合起来。 RPC API 通常根据接口和方法设计。随着时间的推移，接口和方法越来越多，最终结果可能是形成一个庞大而混乱的 API 接口，因为开发者必须单独学习每种方法。显然，这既耗时又容易出错。 引入REST架构风格主要是为了与 HTTP/1.1 配合使用，但也有助于解决这个问题。其核心原则是定义可以用少量方法控制的命名资..
API设计原则
小小程序员
02-13 4573
在设计接口时，有很多因素要考虑，如接口的业务定位，接口的安全性，接口的可扩展性、接口的稳定性、接口的跨域性、接口的协议规则、接口的路径规则、接口单一原则、接口过滤和接口组合等诸多因素，本篇文章将简要分析这些因素。 一、规范性建议 1、职责原则 在设计接口时，必须明确接口的职责，即接口类型，接口应解决什么业务问题等。 2、单一性原则 在明确接口职责的条件下，尽量做到接口单一，即一个接口只做...
22条 API 设计规范，API 一致性设计
LoveSummer
03-17 2307
在这个微服务的世界里，后端API的一致性设计是必不可少的。 今天，我们将讨论一些可遵循的最佳实践。我们将保持简短和甜蜜——所以系好安全带，出发咯！ 首先介绍一些术语 任何API设计都遵循一种叫做“面向资源设计”的原则： 资源：资源是数据的一部分，例如：用户 集合：一组资源称为集合，例如：用户列表 URL：标识资源或集合的位置，例如：/user 1. 对URL使用kebab-case（短横线小写隔开形式） 例如，如果你想要获得订单列表。 不应该： /systemOrders或/system_orders
深度 | API 设计最佳实践的思考
热门推荐
一个天秤座的架构师
08-24 2万+
简介：API 是模块或者子系统之间交互的接口定义。好的系统架构离不开好的 API 设计，而一个设计不够完善的 API 则注定会导致系统的后续发展和维护非常困难。 导读：API 是模块或者子系统之间交互的接口定义。好的系统架构离不开好的 API 设计，而一个设计不够完善的 API 则注定会导致系统的后续发展和维护非常困难。 前言 API 设计面临的挑战千差万别，很难有处处适用的准则，所以在讨论原则和最佳实践时，无论这些原则和最佳实践是什么，一定有适应的场景和不适应的场景。因此我们在...
REST API设计规范
清平乐的技术专栏
07-24 1765
这里整理的REST API的设计规范，注意和后端开发的API接口文档做一下区分，不是一个概念。API是REST API的超集，REST API 是API的子集；所有的REST API都是API，但不是所有的API都是REST API 一、公共要求 API通常使用HTTPs协议，确保交互数据的传输安全，域名尽量将api部署在专用域名下https：//api.example.com，具体公共要求如下 1.在URI中使用小写字母，不要采用驼峰命名。 方便时，在URI路径中应始终首选小写字母。 http://api
c++api设计
05-13
c++api设计，超清版，c++api设计，超清版，c++api设计，超清版，
C++ API 设计
09-15
《c++ api设计》适合具有一定c++ 编程经验的程序员阅读，也适合对api 设计主题感兴趣的读者参考。 　现代软件开发中的一大难题就是如何编写优质的api。api负责为某个组件提供逻辑接口并隐藏该模块的内部细节。多数...
java API设计
03-06
博文链接：https://handmu.iteye.com/blog/38870
C++ API设计
01-06
C++ API设计
pyzmq-25.1.1b2-cp312-cp312-win_amd64.whl
最新发布
06-13
Python库是一组预先编写的代码模块，旨在帮助开发者实现特定的编程任务，无需从零开始编写代码。这些库可以包括各种功能，如数学运算、文件操作、数据分析和网络编程等。Python社区提供了大量的第三方库，如NumPy、Pandas和Requests，极大地丰富了Python的应用领域，从数据科学到Web开发。Python库的丰富性是Python成为最受欢迎的编程语言之一的关键原因之一。这些库不仅为初学者提供了快速入门的途径，而且为经验丰富的开发者提供了强大的工具，以高效率、高质量地完成复杂任务。例如，Matplotlib和Seaborn库在数据可视化领域内非常受欢迎，它们提供了广泛的工具和技术，可以创建高度定制化的图表和图形，帮助数据科学家和分析师在数据探索和结果展示中更有效地传达信息。
wireshark安装教程入门.md
06-13
附件是wireshark安装教程，文件绿色安全，请大家放心下载，仅供交流学习使用，无任何商业目的！
grpcio-1.3.0-cp36-cp36m-win_amd64.whl
06-13
Python库是一组预先编写的代码模块，旨在帮助开发者实现特定的编程任务，无需从零开始编写代码。这些库可以包括各种功能，如数学运算、文件操作、数据分析和网络编程等。Python社区提供了大量的第三方库，如NumPy、Pandas和Requests，极大地丰富了Python的应用领域，从数据科学到Web开发。Python库的丰富性是Python成为最受欢迎的编程语言之一的关键原因之一。这些库不仅为初学者提供了快速入门的途径，而且为经验丰富的开发者提供了强大的工具，以高效率、高质量地完成复杂任务。例如，Matplotlib和Seaborn库在数据可视化领域内非常受欢迎，它们提供了广泛的工具和技术，可以创建高度定制化的图表和图形，帮助数据科学家和分析师在数据探索和结果展示中更有效地传达信息。
Werkzeug-0.12.1.tar.gz
06-13
Python库是一组预先编写的代码模块，旨在帮助开发者实现特定的编程任务，无需从零开始编写代码。这些库可以包括各种功能，如数学运算、文件操作、数据分析和网络编程等。Python社区提供了大量的第三方库，如NumPy、Pandas和Requests，极大地丰富了Python的应用领域，从数据科学到Web开发。Python库的丰富性是Python成为最受欢迎的编程语言之一的关键原因之一。这些库不仅为初学者提供了快速入门的途径，而且为经验丰富的开发者提供了强大的工具，以高效率、高质量地完成复杂任务。例如，Matplotlib和Seaborn库在数据可视化领域内非常受欢迎，它们提供了广泛的工具和技术，可以创建高度定制化的图表和图形，帮助数据科学家和分析师在数据探索和结果展示中更有效地传达信息。
java api设计规范
12-29
Java API设计规范是一套在编写Java程序时应当遵循的一系列规则和准则。遵循这些规范可以使得编写的API更加规范、易于维护和使用。 首先，API设计应当遵循面向接口编程的原则，通过定义接口和抽象类来规范API的使用。接口应当清晰地定义方法和参数，同时应当避免将不相关的功能耦合在一起。 其次，API的命名应当简洁明了，应当符合驼峰命名规则，并避免使用缩写和简写，以保证API的名称易于理解和记忆。 另外，API设计中应当考虑到参数的类型和顺序，应当合理定义方法的参数，并使用合适的类型来表示数据，以便于使用者理解和操作。 API设计中还应当考虑到错误处理和异常的定义，合理地定义异常类型并提供清晰的异常处理机制，以便于使用者在调用API时能够正确地处理异常情况。 此外，API设计应当考虑到文档的编写和发布，编写清晰、详细的文档，并提供示例代码和使用说明，以便于使用者能够快速上手和使用API。 总之，遵循Java API设计规范可以使得API更加规范、易于理解和使用，提高程序的可维护性和扩展性，同时也有利于开发人员之间的协作和沟通。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值