Berlin: Web API设计原则

最新推荐文章于 2024-01-30 01:29:27 发布
转载 最新推荐文章于 2024-01-30 01:29:27 发布 · 881 阅读 · 0

本文分享了RESTful API设计的七大原则，包括避免特定误区如不在API中包含领域模型、不只使用GET和PUT方法等，帮助开发者设计出更高效、易用且符合标准的API。

1，不要考虑端点
2，不要在API中包里领域模型
3，目的明确之后再设计API
3，不要孤独使用GET PUT
4，不要将错误码选择限制为200和500
5，不要忽略缓存
6，不需要版本
7，不要对内容协议进行扩展

http://www.infoq.com/cn/news/2013/10/gotober-do-dont-webapi

ical-to-rest-api
03-16
2. **RESTful API设计**：遵循HTTP协议和REST原则，设计合适的URL路径、HTTP方法（GET、POST、PUT、DELETE等）来暴露日历事件资源。 3. **Express.js或类似的框架**：JavaScript的服务器端框架，用于构建API的路由和...
GOTO Berlin: Web API设计原则
啊啊啊啊2
10-13 250
在邮件列表和讨论区中有很多与REST和Web API相关的讨论，下面仅是我个人对这些问题的一些见解，并没有绝对的真理，InnoQ的首席顾问Oliver Wolf在GOTO Berlin大会上开始自己的演讲“Web API设计原则”时如是说。\u0026#xD;\n不要考虑端点。SOAP有一个单独入口点的外观。相比之下Web有很多入口点，它们建立在关系上，彼此之间相互连接，并且以超媒体作为关键要素。...
设计一个高质量的API接口
weixin_30478619的博客
01-18 1854
参考网址：http://url.cn/5UaTeyv 前言 在设计接口时，有很多因素要考虑，如接口的业务定位，接口的安全性，接口的可扩展性、接口的稳定性、接口的跨域性、接口的协议规则、接口的路径规则、接口单一原则、接口过滤和接口组合等诸多因素，本篇文章将简要分析这些因素。 一、规范性建议 1、职责原则 在设计接口时，必须明确接口的职责，即接口类型，接口应解决什么业务问题等...
高可用、高性能？ 接口设计的 16 个原则
热门推荐
技术杂谈
12-04 2万+
本文来自作者 LY 在 GitChat 上分享「如何设计出高可用、高性能的接口」，「阅读原文」查看交流实录 「文末高能」 编辑 | 嘉仔 发起这个 Chat 只是一时兴起，想了一些点就写出来了，但自己一读，感觉一点干货都没有，真是汗颜。但还是也希望此拙文能带来一些你的思考，欢迎交流。 接口设计需要考虑哪些方面 接口的命名。 请求参数。 支持的协议。
如何设计Web API？
wudawei071193的博客
12-09 463
大多数现代的Web应用程序都公开了客户端可以用来与应用程序交互的API。精心设计的Web API应该旨在支持： 平台独立性。无论内部如何实现API，任何客户端都应该能够调用API。这需要使用标准协议，并具有一种机制，使客户端和Web服务可以就要交换的数据格式达成一致。 服务演进。Web API应该能够独立于客户端应用程序进行演化和添加功能。随着API的发展，现有的客户端应用程序...
七步法：Web API设计方法论
z69183787的专栏
01-15 1912
为Web设计、实现和维护API不仅仅是一项挑战；对很多公司来说，这是一项势在必行的任务。本系列 将带领读者走过一段旅程，从为API确定业务用例到设计方法论，解决实现难题，并从长远的角度看待在Web上维护公共API。沿途将会有对有影响力的人物的访谈，甚至还有API及相关主题的推荐阅读清单。 这篇 InfoQ文章是 Web API从开始到结束系列文章中的一篇，后续我们将继续为您带来文
Delphi RESTful服务构建：Web API创建快速指南
[Delphi RESTful服务构建：Web API创建快速指南](https://opengraph.githubassets.com/fbcbd21cf456657a32e768ba7125dec47cadca9f59dcddf1df3a49c1a3f9bbfd/empari/delphi-request-rest-api-example) # 摘要 本文...
bvg-rest：柏林勃兰登堡公共交通REST API指南
REST API指的是那些遵循REST原则设计的API，它们通常使用HTTP作为传输协议，使用GET、POST、PUT、DELETE等标准的HTTP方法来进行数据的CRUD（创建、读取、更新和删除）操作。 2. 公共交通API应用： 通过提供公共...
【实战演练】：Python课程设计中的5个知识图谱问答系统案例分析
[python课程设计大作业基于知识图谱的问答系统源码（95分以上项目）](https://ucc.alicdn.com/pic/developer-ecology/yq32ha2ascg5a_aa692e076c7d4732889e0c5108013dc4.png?x-oss-process=image/resize,h_500,m_lfit...
低代码构建聊天机器人：从设计到实践
设计一个成功的聊天机器人需要考虑多方面的设计原则。首先，分析目标受众是设计阶段的重要任务，因为这有助于确定聊天机器人的个性和品牌定位。一个吸引人的问候语和流畅的对话导航对每个聊天机器人都至关重要。 在...
软件系统架构黄金法则：高效的API设计原则
AI天才研究院
01-30 1121
1.背景介绍 软件系统架构黄金法则：高效的API设计原则 作者：禅与计算机程序设计艺术 1. 背景介绍 1.1 API的定义和意义 API(Application Programming Interface)，中文名称应用程序编程接口，是一组用于开发和集成软件系统的规范、协议和工具。API允许不同的应用程序之间共享数据和功能，从而提高软件系统的可扩展性、可重用性和可维护性。API的设计质...
Web API规范设计指引
心流汇聚之地
12-25 6155
关于RESTful 应认真考虑要不要使用RESTful规范，不要盲目跟风。它的缺点在小公司里特别明显： 高度抽象，需要一定的设计能力。初级程序员很容易破坏整体设计，这不可能都被Review到。接口使用者也未必能做好反馈 需要对HTTP协议有一定的理解 一般越好的设计就有越多的约束，也可能有越高复杂度，因此交接工作的学习成本高 产品迭代很快时，接口可能变动很频繁导致版本升级也很快，各种为了好设计而...
RESTful API 最佳实践（转载）
雾气
10-10 1485
转载： http://www.ruanyifeng.com/blog/2018/10/restful-api-best-practices.html RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。 它的大原则容易把握，但是细节不容易做对。本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。 一、URL 设计 1.1 动词 + 宾...
Web API接口设计经验总结
weixin_34396902的博客
09-29 983
在Web API接口的开发过程中，我们可能会碰到各种各样的问题，我在前面两篇随笔《Web API应用架构在Winform混合框架中的应用（1）》、《Web API应用架构在Winform混合框架中的应用（2）--自定义异常结果的处理》也进行了总的介绍，在经过我的大量模块实践并成功运行后，总结了这篇随笔，希望对大家有所帮助。 1、在接口定义中确定MVC的GET或者POST方式 由于我们整个Web...
Web API 的设计风格
离阳的博客
08-26 1085
一直在做APP后台，顺便总结下API应该怎样去写。API的设计风格一般是遵循RESTFul设计风格的。 GET 请求遵循下面的格式。 请求     1. 头信息   Accept: application/json Content-Type: application/json;charset=utf-8 Accept-Language: <语言代码> ...
如何设计优美的 WEB API？
GitChat
07-03 1128
构建前后端分离的 WEB 应用或跨终端的移动应用、集成内外部系统、对外开放服务、开发可嵌入其他网页微件等，这些场景都离不开 WEB API。虽然我们经常使用他人提供的 WEB API，但如何评判它们的优劣呢？我们也经常设计开发 WEB API，但如何让它们更易于使用、方便更改和牢固健壮呢？ 在设计 WEB API 的过程中，我们需要确定它的调用地址、请求方式（HTTP 方法）、请求参数（Heade...
Web API 设计摘要
iteye_2022的博客
06-24 196
最近读了一本微电子书 Brian Mulloy 所著《Web API Design》感觉颇多收获，特对其内容做了个整理摘要以便回顾其观点精华以指导日常工作中的设计思路。 本文主要讲述 Web API 设计，追求一种更务实的 REST 风格。 正如作者所说 REST 是一种架构风格，而非严格的标准，没必要在形式定义上去做过多真论，到底什么才是真正的 REST？ 设计的目的是为了表达某样...
Web Api安全性设计
Fanbin168的专栏
03-29 6804
分布式通讯框架-->一个系统要访问另外一个系统中的数据,有一下三种方法，第一种分为2种 1.0 ,MVC Webapi  (严格的讲它其实仅仅是一个设计方案，而不是一个设计框架，Webapi流行的标准RESTfu) （也需要做安全性设计） 1.1 , 自己写一个.ashx一般处理程序 （它其实就是提供一个url供别人调用，这个url返回一个xml或者一个Json格式的数据，但是
web接入微博第三方登录
iteye_1866的博客
12-30 713
微博第三方登录 最近刚好在学习第三方登录，这里先做一下微博第三方登录的记录，因为qq第三方登录必须要完成网站备案后才能进行，后面再进行补充。 大致可以分成下面几个步骤 下面根据我自己的实现过程做一下总结吧。 准备工作 （1）首先需要有一个准备接入第三方登录的引用，这里可以是自己的一个小案例web项目。 （2）需要准备一个域名，并判定自己的应用，这样通过微博审核才能获取到app ...
技术转移服务公司如何借助AI赋能的科技管理服务挖掘服务价值？.docx
最新发布
12-02
技术转移服务公司如何借助AI赋能的科技管理服务挖掘服务价值？
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值