文档建议反馈控制台
首页
学习
活动
专区
圈层
工具
MCP广场
文章/答案/技术大牛
发布

一个“爆款”成功的API，都离不开这8条设计准则

我已经看过很多API设计相关的文章和优秀的REST API设计教程。他们通常讨论的是适当的编码技巧和如何在给定的语言中暴露接口。...因为作为一个API的使用者我不想去猜每个接口的每个参数值类型。 除了需要考虑你的接口如何访问数据以外，你也应该好好想一下你的API如何返回数据以及返回数据格式的统一性。...原因是如果我遍历每个元素来寻找这个属性，我希望至少能找到它，即使它没有值。然而现在就像是从数据库查出几条记录然后发现有几条数据里面没有某个字段而其他几条却有。...如果你的某个API是负责创建一个product的，那么就让它执行完创建操作后返回一些有关刚刚创建的product的相关信息，而不是去要求客户端再去发送一个请求来获取你刚刚创建的product的相关信息。...所以你的API不要让客户端调用多次只是为了去做一个通常都需要执行的子任务！你可以通过提供默认参数值而且允许客户端可以根据特定请求去覆盖你的任意一个默认参数值来解决这个问题。

1K70

爬虫入门及HTTP协议的讲解

http://zhuanlan.zhihu.com/pachong ❈— 1.引言 我经常会看到有人在知乎上提问如何入门 Python 爬虫？如何学习Python爬虫[入门篇]？...；爬虫能帮我们省掉一系列繁琐的时间（比如我要下载我爱看图这个网站的图片，我不可能一张一张的点，我可以写一个爬虫帮我全部下载完） 3.爬虫的本质是什么 爬虫的本质我觉得就是一句话 模仿浏览器去打开网页 我们来看一个例子吧...： GET 请求获取Request-URI所标识的资源 POST 在Request-URI所标识的资源后附加新的数据 HEAD 请求获取由Request-URI所标识的资源的响应消息报头 PUT...保留将来使用 OPTIONS 请求查询服务器的性能，或者查询与资源相关的选项和需求 应用举例： GET方法：在浏览器的地址栏中输入网址的方式访问网页时，浏览器采用GET方法向服务器获取资源，eg...HEAD方法与GET方法几乎是一样的，对于HEAD请求的回应部分来说，它的HTTP头部中包含的信息与通过GET请求所得到的信息是相同的。

1.3K90
    • 您找到你想要的搜索结果了吗？
    是的
    没有找到

    REST 十诫

    如果你将 API 端点命名为 /getUsers，并且你在进行一个 GET 请求来查看所有的用户，那么你读这个语句的时候会觉得很有趣。GET getUsers。没有意义。...更酷的是，你可以请求 GET /users/:id 来获取信息，以便了解更多的细节。所以，就像你所见：它仍然是相同的起始资源名称，只不过有了更多的深度。...同样，没有人可以阻止你使用其中任何一种，从理论上讲，你是不会出错的。不过，我推荐使用 snake_case。为什么？Stripe 使用它。PayPal 使用它。Facebook 也使用它。你知道吗？...因为我们响应的状态代码是 401（未授权），所以大家都知道这是客户端故障，必须通过客户端来解决，而非 API。我只是举一个例子，但我的意思是，你应该在适当的情况下使用适当的 HTTP 状态代码。...一个聪明的 API 会知道哪个客户端在访问这个端点，并会返回它自己的优化资源，甚至允许客户端请求特定的尺寸。这样的例子还有很多，不过你会明白的。 尽可能减少客户端的依赖性。

    65820

    通过Password Vault的XSS漏洞获取用户密码测试

    那么，作为存储如此敏感数据的管理工具是否应该保证足够的安全性呢？ ? 场景 在我遇到的这个场景中，其中不仅包含了账户密码它还包含了该公司员工的密码。...在仔细观察应用程序并完成各个请求之后，我发现应用程序会从位于应用程序的/api/的API中检索不同的信息。 在对应用程序进行一些爬行和抓取后，我发现了一些API端点： ?...这将返回指定ID的以下信息： ? 现在我们已经知道了ID是如何被检索的，以及它们是如何返回数据的。但有个问题就是，应用程序在发送给API的每个POST请求中都发送了一个CSRF token。...session/token 端点 为了弄清楚token是如何生成的，我查看了其它的一些端点，最终发现位于/api/v1/session/token的API端点是负责生成CSRF tokens的。...发送一个GET请求至该端点，你将会获取到以下响应： ? XSS漏洞 现在，我们开始了解应用程序的流程和用于数据交换的端点。

    2K30

    REST，以及RESTful的讲解

    如果不是因为Get不支持大数据传输，我想连Post都不会有人使用。...所以你能理解到的程度，更多的就是在于你要弄清楚你要解决的什么问题，如果你的问题只是理解Rest，恐怕你很理解，如果你的问题是怎么解决Url混乱的问题，你反而很快能弄懂了~ 对比 https://localhost...比如：左边是错误的设计，而右边是正确的 GET /rest/api/getDogs --> GET /rest/api/dogs 获取所有小狗狗 GET /rest/api/addDogs...方法：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源，这样就统一了数据操作的接口，仅通过HTTP方法，就可以完成对数据的所有增删查改工作。...PUT（UPDATE）：在服务器更新资源（客户端提供完整资源数据）。 PATCH（UPDATE）：在服务器更新资源（客户端提供需要修改的资源数据）。

    93030

    GraphQL是API的未来，但它并非银弹

    1 REST 的缺点 作者指出了 REST API 的一系列缺点，以及 GraphQL 如何克服所有这些缺点： 过度获取； 多个请求请求多项资源； 针对嵌套数据的瀑布式网络请求； 每个客户端都需要知道每个服务的位置...你可以将多个调用封装到一个 API 中，让它们在服务器端完成，而不是从客户端发出多个请求。此方法也可以解决过取和欠取问题，因为你可以在将数据发回客户端之前对其进行操作。...你不是必须首先将所有查询转换为 GET 请求吗？要是那样的话，你的 GraphQL 客户端和服务器是否很容易支持这一点？ 在用户体验和开发易用性方面，显然 BFF 是赢家。...如何对用户进行身份验证？需要 API 密钥吗？要使 API 文档能帮助 API 消费者使用，所需做的工作比向类型和字段添加描述要多得多。OAS 允许你添加有效负载示例并描述它们。...使用 GraphQL，解析部分数据的逻辑位于服务器中。客户端需要有额外的逻辑对部分响应做相应的处理。 使用 REST，获取部分数据的逻辑位于客户端或 BFF 中。

    2.6K10

    如何发现Web App Yummy Days的安全漏洞？

    在本文中，我将向你展示我是如何发现Web App Yummy Days的安全漏洞的，以及如何构建一个简单的自动客户端，让我获得Yummy Days促销的奖品。...反之，你则会从沙拉中取出紫色的生菜（或其他紫色的东西），这表示你没有中将。 我玩了三四天这个游戏，获取到了大概300个Yums！ ?...Postman是一个客户端，它允许我们向API发出HTTP请求，并在每个请求前后执行代码片段。 ?...你还记得之前我使用Google Chrome Developer Tools记录的游戏过程中的所有请求吗？现在我们就要用到这些请求了。...最后在Play请求中，我将复制触发动画按钮的行为，以检查你是否赢得奖品。这是对URL的简单GET，使用前一个请求的相同标头。

    2.5K20

    OpenAI 演讲：如何通过 API 将大模型集成到自己的应用程序中

    下一步是，我们要弄清楚我们到底想要如何调用这个函数。我们可以根据特定参数从get_current_tweather的函数调用中获取相应的返回值。然后我们可以自己执行。...这是一种快速的方法，它可以了解完全的自然语言、完全的自然语言查询是如何将结构化输出转换为有效的 SQL 语句的，我们在数据库中运行该语句，获取数据，并将其汇总回自然语言。...让我们用 GPT 来运行一下它，看看它是如何做的。 当然，GPT 不知道我们在哪里，所以它说get_current_location，我们将调用本地 API 来获取我们的纬度和经度。我们已经获取到了。...这就是我想要的。让我们调用 Yelp 并获取一些数据。 我们从 Yelp API 中获取了一堆餐馆。当然，我希望它能给出一个漂亮的总结，所以让我们再次运行它。...它再次使用完全有效的 JSON 调用该函数。它说，“很高兴看到你检索角色值。”；“你的错误信息简洁明了。”；“我很感激你对数据库的更改，做得很好。”。我希望有人能这样审查我的代码。

    2.9K10

    GraphQL最突出的架构优势是什么？

    在外部，你能找到数据库、外部 API、云服务和种种内容。如果我们采用依赖倒置方法，就可以定义一些端口来将它们安全地包含在我们的应用程序中。端口是抽象、合约。...，我们可以使用 @client 指令来引用要基于一个客户端模式从本地缓存中获取的属性。...数据图从客户端延伸到服务器，并为现代 Web 应用程序中获取数据和更改状态时面临的最常见基础架构问题提供了答案 为了通过 GraphQL 与后端服务通信，Apollo Client 公开了几种客户端方法...，这些方法在被调用时会将操作转换为适当的 API 以跨越数据图。...API 客户端了解如何解决该请求的唯一方法是检查错误响应（指望错误消息描述了所需的信息，否则也没用）。

    3.1K20

    好 RESTful API 的设计原则

    我之所以说“半个”的意思是PATCH这个动词非常类似于PUT，并且它们俩也常常被开发者绑定到同一个API上。 GET (选择)：从服务器上获取一个具体的资源或者一个资源列表。...让API根拥有一些内容通常也是个好主意。Github的API根就是一个典型的例子。从个人角度来说我是一个通过根URL发布信息的粉丝，这对很多人来说是有用的，例如如何获取API相关的开发文档。...过滤器 当客户端创建了一个请求来获取一个对象列表时，很重要一点就是你要返回给他们一个符合查询条件的所有对象的列表。这个列表可能会很大。但你不能随意给返回数据的数量做限制。...另外一个不那么重要的原因是（从客户端角度来说），对服务器来说响应请求的负载越少越好。 过滤器是最有效的方式去处理那些获取资源集合的请求。所以只要出现GET的请求，就应该通过URL来过滤信息。...如果一个URL曾经被缓存过，并且在随后的请求中返回404错误，那么客户端可以很简单的回退到根URL并重新发现内容。 在获取集合中的一个资源列表时会返回一个属性，这个属性包含了各个资源的完整URL。

    1.3K20

    WEB性能(7)--XMLHttpRequest

    XHR诞生以前，网页要获取客户端和服务器的任何状态更新，都需要刷新一次。有了XHR，这个过程就可以异步实现，而且完全通过应用的JavaScript代码完成。...然而，XHR的能力不仅仅表现在能实现浏览器的异步通信，还表现在它极大的简化了这个异步通信过程。...XHR是浏览器提供的API，这就意味着浏览器会自动帮我们完成所有底层的连接管理、协议协商、HTTP请求格式化等等很多工作。...客户端被限制只能发送“简单的跨域请求”,包括只能使用GET、POST和HEAD，以及只能访问可以通过XHR发送并读取的HTTP首部。...七、XHR使用场景及性能 XMLHttpRequest是我们从在浏览器中做网页转向开发web应用的关键。首先，它让我们在浏览器中实现了异步通信，但同样重要的是，它还把这个过程变得非常简单。

    1.1K10

    前端要知道的RESTful API架构风格

    前端程序员在开发完页面后总是要对接口的，跟后端联调有时候还占用蛮大的时间的，那么你了解你和后端对的接口都是什么风格吗，你们公司接口设计的如何，你使用愉快吗？...自己在写Node服务时你遇到如何定义好接口的问题吗？下面介绍一种API架构风格，也是目前主流的API设计风格，你或许一直在使用。 ? RESTful API 示例 REST是什么？...HEAD：获取资源的元数据。 OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。...uploadfile.php - 上传创建文件 api/deletefile.php - 删除文件 RESTfu，api/file 只需要这一个接口： GET 方式请求 api/file - 获取文件信息...，下载文件 POST 方式请求 api/file - 上传创建文件 DELETE 方式请求 api/file - 删除某个文件 常见笔试题:什么是 RESTful API，如何设计RESTful API

    1.2K30

    关于HTTP报文请求方法和状态响应码

    Method 请求方法，表明客户端希望服务器对资源执行的动作； 1.1 GET 向服务器请求资源。 1.2 HEAD 和GET方法的行为类似，但服务器在响应中只返回首部，不会返回实体的主体部分。...可以做到： 不获取资源的情况下了解资源的情况(比如，判断器类型) 通过查看响应中的状态码，看看某个对象是否存在； 通过查看首部，测试资源是否被修改了； 1.3 PUT 与GET从服务器读取文件相反，PUT...1.4 POST 向服务器发送要处理的数据； 一般服务器通常提供一个表单，客户端填入数据后点击提交(提交是数据都会放在请求报文的实体部分当中)，然后由服务器将其发送到它要去的地方（比如，送到一个服务器的网关程序中...客户端可以通过一些特殊的首部来获取部分或某个范围内的文档--这个状态码就说明范文请求成功了； 206相应中必须包含Content-Range、Date以及ETag或Content-Location首部；...通常会包含一个实体，以便客户端应用程序显示给用户看； 405：Methord Not Allowed 发起的请求中带有所请求的URL不支持的方法时，使用此状态吗。

    1.9K30

    从全栈工程师视角看Java与前端技术融合的实战经验

    **面试官**：很好，那你能举一个你在前端开发中遇到的具体问题，并说明你是如何解决的吗？ **应聘者**：有一次我们在做一个内容社区的项目时，遇到了页面加载性能问题。...**应聘者**：Axios用于发送HTTP请求，获取或提交数据。比如在商品详情页，我们会用它来获取商品信息、库存状态等数据。...```javascript // 使用Axios发送GET请求获取商品信息 axios.get('/api/products/' + productId) .then(response => {...同时，我们也使用了拦截器来统一处理错误信息和请求头。 **面试官**：你提到Spring Boot，能谈谈你在Spring Boot项目中常用的依赖管理工具吗？...**应聘者**：是的，我们使用Redis作为缓存数据库，用来存储高频访问的数据，如商品信息和用户会话。 **面试官**：那你能举一个Redis在项目中的实际应用例子吗？

    15810

    开学第一课：拜托，一定不要这样问Python问题

    4.为啥我的Socket程序客户端连接不上服务端呢？ 5.请问你会用Python做网站吗？/请问群里有懂Python做网站的吗？ 6. ? 7.我的代码可以运行，但是结果不对，如下，我该怎么办？ ?...12.从完整程序中截图几行代码片段，然后问有什么错误。 13. ? 14.（发一个程序文件）老师，这程序里有个错误，你帮我找出来修改一下吧。...19.我有个特别特别简单的问题，但在网上就是查不到解决办法，你能告诉我该怎么办吗？ 20.别人提供了大致思路之后，不去试验一下，而是凭想象和脑补一直追问技术细节，恨不能拿到完整代码。...21.错误截图不完整，完美漏掉最关键的部分， ? 22. ? 23.我自己的老师说我的程序中至少有3处错误，又不告诉我哪里有错误，我找不出来，你能帮我找出来改一下吗？...举手之劳很少有人会拒绝，但是如果需要花费大量时间来猜你到底问的是什么，需要为了解决这个问题专门搭建环境安装扩展库，需要照着你的代码截图自己敲一遍，需要花大量时间来设计测试数据并且根据你提供的几行代码片段甚至压缩到不能再少的几行出错提示来推测代码是什么样子以及为什么出错和怎么修改

    93210

    DjangoRestFramework，restful规范、APIview、解析器组件、Postman等

    ，为什么get请求就能找到类的get方法，post请求就能找到post方法，其内部有个dispatch方法来进行分发，这又怎么玩呢，看源码啦，从哪里看呢？...URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态 　　　　所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性...他和put用哪个都可以，没有太大的区别，我们用put方式偏多 DELETE（DELETE）：从服务器删除资源。 　　　　　　还有两个不常用的HTTP动词。 HEAD：获取资源的元数据。...有人就又说了，我们这么写也ok啊，要drf干嘛，上面这个例子是个简单的例子，数据简单、逻辑简单，你这样写当然看着没有问题啦，但是数据量很大，结构很复杂的时候，你这样写的时候就头疼了。 　　...return HttpResponse('POST') 　　　　　　而DRF通过自己的解析器，帮我们给request里面封装了一个request.data属性，获取请求体里面的数据，然后解析

    3.1K20

    REST 架构-架构快速进阶教程

    此外，内部实现与资源表示是分开的。此外，表示应提供修改或删除资源或获取附加数据的所有信息。 客户端-服务器体系结构。客户端使用 URI 获取资源。它不涉及服务器如何处理请求。...缓存更新的数据很少能提高性能并消除冗余的客户端-服务器交互。 分层系统。REST API 可以由多个层组成，例如业务逻辑、表示、数据访问。此外，图层不应直接影响其他图层。...HTTP 方法描述客户端要对资源执行的操作。有四种最常用的基本方法：获取、发布、放置和删除。让我们定义它们。 第一个，GET用于读取资源。服务器返回给定 URI 的资源。GET 方法不包含正文。...因此，它表明考虑到 REST 约束，API 的质量很好。 0级被称为痘沼泽。在这个层面上，API并没有使用HTTP协议的全部潜力，通常，它只使用POST和GET方法。因此，HTTP 协议仅用作传输层。...简而言之，我们添加与所需资源相关的其他资源的 URI。为了澄清，让我们看下面的例子。在用户响应中，我们嵌入了一个地址 URI，通过使用它，客户端可以获取地址详细信息。

    31710

    测试开发-web开发和flask

    B/S架构中Browser和Server进行通信的协议,基于TCP/IP Http请求四要素 请求方法: Restful API中主要用于表明请求的行为 请求url: 请求资源路径 请求头: token...响应体: 放置Browser想要的数据 HTML 即Hybridtext Mark Language: 超文本标记语言 web开发技术实现 要弄清楚如何进行web开发, 首先要先弄懂web服务器如何提供服务...从外部看 我们发送一个Http请求给服务器, 服务器返回我们想要的数据,数据可以分为2种: 静态资源: 服务器返回了一张图片, 一个视频,一个文档 动态资源: 服务器根据请求返回对应的数据, 数据一般来自数据库...从内部看 web服务器首先要完成这么几件事: 网络底层: 搞定TCP握手挥手等网络底层交互的事 解析请求: 对HTTP原始请求进行解析 准备响应数据: 根据请求, 加入响应状态码以及响应头 准备数据放在响应体中...如何将这些接口的业务实现代码组合起来的, 这个时候我们就需要web框架了 Web框架 web框架建立业务代码与 请求方法+请求路径 的映射, 而我们只要对根据请求实现对应的业务代码 以flask为例

    42010
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

      Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有

      深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 粤公网安备44030502008569号

      腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号

      领券