REST API最佳实践:数据应该在POST请求中传递到哪里？参数、端点、主体？

REST API最佳实践中，数据应该在POST请求的主体（body）中传递。

在REST API中，POST请求用于创建资源或执行某些操作。当需要向服务器发送数据以创建或更新资源时，可以将数据作为请求的主体内容进行传递。

具体来说，可以将数据以JSON、XML或其他格式编码，并将其作为POST请求的主体内容发送到服务器。这样可以确保数据的完整性和安全性，同时也可以传递更大量的数据。

以下是数据在POST请求中传递到主体的一些优势和应用场景：

数据完整性：将数据放在主体中可以确保数据的完整性，避免数据被篡改或丢失。
数据安全性：通过使用HTTPS协议进行传输，可以保证数据在传输过程中的安全性。
大数据传输：主体中可以传递更大量的数据，适用于需要传输大型文件或大量数据的场景。
复杂数据结构：主体中可以传递复杂的数据结构，例如嵌套对象或数组。

对于腾讯云相关产品和产品介绍链接地址，可以参考以下推荐：

腾讯云API网关：https://cloud.tencent.com/product/apigateway
腾讯云云函数（Serverless）：https://cloud.tencent.com/product/scf
腾讯云容器服务（TKE）：https://cloud.tencent.com/product/tke

请注意，以上推荐仅为示例，实际选择产品时应根据具体需求进行评估和选择。

相关·内容

REST API 最佳实践

在这篇文章中，我将带你了解创建 REST API 时需要遵循的一些最佳实践。这将帮助你创建最好的 API，并使你的 API 用户使用起来更容易。 0.什么是 REST API？...1.REST API 设计建议 1.用名词表示资源当你设计一个 REST API 时，你不应该在端点路径中使用动词。端点应该使用名词，表示它们各自的作用。...5.用过滤、排序和分页请求数据有时，API 的数据库可能非常大。如果发生这种情况，从这样的数据库中检索数据可能非常缓慢。过滤、排序和分页都是可以在 REST API 的集合上执行的操作。...first-name=john&last-name=doe 虽然在技术上两者都是有效的，但使用下划线的查询参数更符合 REST API 的最佳实践，并且更容易读写和阅读。...删除多个评论 5.小结在这篇文章中，你了解了在创建 REST API 时需要记住的几个最佳实践。

1.6K2 0

什么是REST API

不同的HTTP方法可以在任何端点上使用，这些方法映射到应用程序的创建、读取、更新和删除（CRUD）操作： HTTP方法CRUD行为GET读取返回请求数据POST创建创建一个新记录PUT 或者 PATCH...数据通常在HTTP主体中传输，该方式与HTML提交或者发送单独的JSON编码的数据字符串等方式相同。...要深入了解实现策略，请看13个构建RESTful API的最佳实践[14]。端点共识考虑下面的端点： /user/123 /user/id/123 /user/?...API密钥[17]。第三方应用程序通过发布一个密钥来获得使用API的许可，这个密钥可能有特定的权限或被限制在一个特定的域。密钥在每个请求中的HTTP头或查询字符串中被传递。 OAuth[18]。...下一篇文章中，会翻译分享13个构建RESTful API的最佳实践[27]，欢迎关注。

4.2K2 0

REST API 设计最佳实践：如何构建、设计和使用 API ？

因此我决定写篇文章分享一下，在设计 REST API 时的最佳实践。以下是关于设计优秀REST API 的一些建议、提示和指导，帮助您让消费者（以及开发人员）满意。 1....在响应体中返回错误详情当API服务器处理错误时，将错误详细信息包含在JSON主体中可以帮助使用者进行调试，这是是非常方便的，如果您还能说明哪些字段受到了错误的影响，那就更好了！...使用专门针对REST API的网络框架作为最后一个最佳实践，让我们讨论这个问题：如何在您的API中实际应用最佳实践？大多数时候，您希望建立一个快速的API，以便一些服务可以相互交互。...因此，在API中应用最佳实践需要采取额外措施。而且大多数时候, 懒惰或缺乏时间意味着你不会付出努力——从而使你的消费者面临一个古怪的API。解决方案很简单：使用合适工具完成任务。...各种语言中已经出现了新框架, 它们专门用于构建REST APIs。它们能够帮助您轻松遵循最佳做法，并提高生产力。在Python中, 我找到过其中之一优秀API框架就是Falcon。

3504 0

你确定你的 REST API 真的符合 REST 规范？

RESTful API 背后的思想是遵循REST 规范中描述的所有架构规则和限制的方式进行开发。然而，实际上，这在实践中基本上是不可能的。一方面，REST 包含了太多模糊和模棱两可的定义。...例如，在实践中，HTTP 方法和状态码中的一些术语的使用与其预期目的相反，或者根本不使用。另一方面，REST 开发产生了太多的限制。...所有资源的描述，包括标识符、HTTP 方法、所有输入参数、响应代码和主体数据类型，以及指向定义的链接。所有可用于输入或输出的定义，以 JSON 模式格式。...) }; }); 最佳实践 OK，介绍了以上内容之后，让我们来做一下遵循规范的最佳实践。...基于客户端类型分离端点通常，相同的端点会根据客户端类型或发送请求的用户角色返回不同的数据。例如，对于移动应用程序用户和后台管理人员来说，GET /uses 端点可能存在很大的不同。

2232 0

13个构建RESTful API的最佳实践

在今天的开发环境中，RESTful API仍然是服务和消费数据的最佳选择之一。但你是否考虑过学习行业标准？设计一个RESTful API的最佳实践是什么？...然而，许多开发者往往会滥用GET和POST，或者PUT和PATCH。通常情况下，我们看到开发者使用POST请求来检索数据。...RESTful API的最佳实践描述了一个端点应该以资源名称开始，而HTTP的操作则描述了行为。...通常，API的版本号被纳入API的URL中，比如：api.com/v1/authors/3/books。通过HTTP头发送元数据 HTTP头允许客户在其请求中发送额外的信息。...这仍然是传递关于你新开发的API知识的最简单的方法之一。尽管你的API遵循了所有针对RESTful API的最佳实践，但仍然值得你花时间来记录各种元素。

1.3K2 0

微服务构建持久API的7大规则

当我们创建SparkPost API时，我们试着不要太过学究式地使用纯粹的REST模型，而是选择易于使用。下面是两个可能不遵循RESTful最佳实践的示例: 1. ...POST/api/v1/sending-domains/example.domain.com/verify 第一个示例使用查询字符串参数来过滤实体中返回的内容。...· URL查询参数和JSON字段也是小写的下划线，并且是大小写敏感的。 · 请求主体中的非预期查询参数和JSON字段应该被忽略。治理组还为如何进行更改以及允许哪些类型的更改设置了基本规则。...有一些很好的API更改对用户是有益的，并且不会破坏它们的集成，包括: · 一个新的API资源、端点或现有资源上的操作。 · 一个新的可选参数或JSON字段。 · 在JSON响应主体中返回的新字段。...相反，一个破坏性的变化包括任何可能破坏用户集成的东西，比如: · 更改字段的数据类型。 · 一个新的必需参数或JSON 字段。 · 删除现有端点或请求方法。

8530 0

13 个设计 REST API 的最佳实践

避免在 URI 中使用动词如果你理解了第 1 条最佳实践所传达的意思，那么你现在就会明白不要将动词放入 REST API 的 URI 中。...但与此同时，结合第 4 点最佳实践，我们就不太能够分清当前端点返回的数据到底是 author 类型还是 article 类型。...采用 REST API 定制化的框架作为最后一个最佳实践，让我们来探讨这样一个问题：你如何在 API 的实施中，实践最佳实践呢？...因此，你必须采取额外的步骤来实施 API 中的最佳实践，但大多数情况下，由于懒惰或者时间紧张等因素，意味着你不会投入过多精力在这些方面 —— 然后给你的用户提供了一个古怪的 API 端点。...在各种语言中，许多专门用于构建 REST API 服务的新框架已经出现了，它们可以帮助你在不牺牲生产力的情况下，轻松地完成工作，同时遵循最佳实践。

3.5K2 0

⚡REST 和 SOAP 协议有什么区别？

例如，在 REST API 中，通常只需一个 URL 端点，通过发送 POST 或 PUT 请求即可完成资源的创建或更新。而在 SOAP 中，创建或更新数据对象需要分别调用处理这些特定操作的独立函数。...### REST 剖析REST API 由以下部分组成：* **请求方法：** 希望对资源执行的 CRUD 操作。在本例中，HTTP 方法 POST 表示希望创建某个内容。...此部分包括函数名（过程）和你希望传递的参数，这些将影响结果。在响应中，Body 部分包含 API 的响应以及所请求的信息。* **Fault（错误）：** 可选的部分。...请求会被发送到一个处理检索的过程（GetPet 函数）。* 参数： * REST - 宠物 ID 作为路径参数传递给端点 URL。...这是通过 REST 使用 URL 分离端点并利用 HTTP 请求头执行 CRUD 操作实现的，而 SOAP 则因其 POST 请求方式而难以实现缓存。

680 0

构建强大REST API的10个最佳实践

在项目开发中，我们经常会使用REST风格进行API的定义，这篇文章为大家提供10条在使用REST API时的最佳实践。希望能够为你带来灵感和帮助。...为了保持版本的兼容性，依旧流量和功能的控制等，通常需要对API进行版本控制，这个是仅限于REST API，而是比较通用的一条最佳实践，特别是真的终端是APP的情况。...错误上下文：与错误相关的附加信息，例如请求ID、导致错误的请求参数或导致错误的请求中的字段。错误链接：提供有关错误以及如何解决错误的附加信息或文档的URL。时间戳：错误发生的时间。...然而，这种方法违反了RESTful API的关键原则：它们需要是无状态的。 10、文档化你的API 为你的API提供全面的文档，包括端点细节、请求/响应示例和使用指南。...建议： Swagger/OpenAPI文档基于Markdown的文档（例如，使用Swagger UI或Redoc等工具）以上便是10条关于REST API使用过程中的10条最佳实践，其中一部分不仅仅是针对

1781 0

API设计：先思考再编码

API是定义应用程序接口的通用术语，换句话说，定义了用户（人或机器）如何与程序交互。在Web开发世界中，API通常是响应客户端结构化文本数据请求的网站端点集合。...除了蓝图，还有MSON（Markdown语法对象符号），它以人类可读的方式定义数据结构，不是手动编写端点的主体数据，而是在可重用对象中表示它们。...参数：在端点中用于指定动态参数，如ID或查询搜索。响应：内容类型，HTTP状态代码和主体数据。除此之外，蜜蜂是一个协作平台，用于创建、呈现、测试和服务您的API。...但在你开始启动你的系统之前，这里有一些小提示：该做什么和不该做什么这里是简单设计规则和最佳实践： 1.将端点操作视为CRUD（L）操作我们的/cakes/端点可能有创建，读取，更新，删除和列表操作...为每个端点，方法，参数，输入和输出数据编写测试。你的API是一种新的小语言，你必须教会其他人使用它。

1.1K3 0

flask 应用程序编程接口（API）最后一节

我还需要其反向处理的方法，即客户端在请求中传递用户表示，服务器需要解析其转换为User对象。...url_for()的参数将相应的特定资源集合，所以我将依赖于调用者在endpoint参数中传递的值，来确定需要发送到url_for()的视图函数。...由于许多路由都需要参数，我还需要在kwargs中捕获更多的关键字参数，它们相互传递给url_for()。page和per_page查询字符串参数是明确的通知，因为它们控制所有API路由的分页。...to_collection_dict()的最后两个参数是端点名称和id，id将在kwargs中作为一个额外关键字参数，然后在生成链接时将它传递给url_for()。...这是一个经常被替代的安全最佳实践。revoke_token()方法始终将其分配给令牌的令牌，只需设置终止时间为当前时间的前一秒。

5K1 0

你还在用 REST API 吗？

REST（Representational state transfer，表述性状态转移）是一种 API 设计架构，用于通过使用一组预定义的无状态操作（包括 GET、POST、PUT 和 DELETE...灵活性是使用 REST 的另一个优势，因为可以将其设计成处理不同类型的调用并返回不同的数据格式。 REST 的劣势抓取过度——这是指 API 端点提供的信息比客户端所需要的要多得多。...抓取不足——这是指 API 端点并没有提供所需的全部信息。因此，客户端必须发出多个请求才能获取应用程序所需的全部内容。什么是 GraphQL？...这也意味着我们可以定制我们的请求，这样我们就可以从端点发出任何请求，并且能获得我们所请求的任何内容，仅此而已，无需更多操作。我们传递查询并得到响应。...结论与 REST 相比， GraphQL 当然更具优势，但它可能并不总是最佳实践。正如我前面所说的，是选择 REST 还是 GraphQL，取决于我们的应用程序。

1.5K1 0

Spring Cloud Task 任务执行-通过调用 REST API 启动任务

Spring Cloud Task提供了REST API来启动任务。通过REST API启动任务使我们能够从其他应用程序或脚本中启动任务，从而进一步提高了任务的可用性和灵活性。...Spring Cloud Task提供了一个/tasks/execute端点，可以使用该端点启动任务。以下是使用REST API启动任务的示例：POST /tasks/execute?...name=myTask在这个示例中，我们使用POST方法调用/tasks/execute端点，并使用name参数指定要启动的任务的名称。...我们还可以通过在请求正文中添加任务参数来传递任务参数。例如，以下是使用REST API传递任务参数的示例：POST /tasks/execute?...name=myTask{ "jobId": "1234", "jobType": "IMPORT"}在这个示例中，我们使用JSON格式的请求正文传递了两个任务参数jobId和jobType。

9762 0

【译】构建RESTful API的13种最佳实践

Facebook、GitHub、Google 以及其他许多巨头都需要一种服务和消费数据的方式。在当今的开发环境中，RESTful API 仍然是服务和消费数据的最佳选择之一。...可以在 RESTful API 中访问以下 HTTP 操作： GET 请求：检索资源 POST 请求：创建资源或将信息发送到 API PUT 请求：创建或替换资源 PATCH 请求：更新现有资源 DELETE...尽管如此，许多开发人员还是倾向于滥用 GET 和 POST 或 PUT 和 PATCH。通常，我们看到开发人员使用 POST 请求来检索数据。...RESTful API 最佳实践描述了端点应以资源名称开头，而 HTTP 操作则描述操作。...6.如何处理搜索，分页，过滤和排序搜索，分页，过滤和排序等操作并不代表单独的端点。这些操作可以通过使用随 API 请求提供的查询参数来完成。例如，让我们检索按名称升序排列的所有作者。

1.9K1 0

Java一分钟之-GraphQL：查询语言与API设计

在现代Web开发中，GraphQL作为一种革命性的查询语言和API设计规范，正逐步改变我们构建和消费API的方式。它允许客户端精确请求所需的数据，从而减少了过载和冗余，提高了应用的性能和灵活性。...GraphQL核心理念 GraphQL的核心在于提供一种声明式的数据查询方式，它允许客户端定义所需数据的结构和字段，而不是依赖于固定的REST API端点。...过度查询与N+1问题问题描述：客户端可能请求过多数据，导致性能瓶颈，或在关联查询中遇到N+1查询问题。解决方案：实施数据加载策略，如Dataloader，预先批量加载关联数据。...解决方案：遵循最佳实践，保持Schema简洁、模块化，合理组织类型和接口。 type Query { user(id: ID!)...安全第一：从设计之初就考虑API的安全性，包括认证、授权和数据过滤。持续学习与实践：跟踪GraphQL社区动态，参与讨论，不断优化API设计。

881 0

Microsoft REST API指南

这些准则旨在达成如下目标：为Microsoft技术平台所有API端点定义一致的实现和体验。尽可能地遵循行业普遍接受的 REST/HTTP 最佳实践。...分类作为Microsoft REST API指南的一部分，服务必须符合下面定义的分类法。 5.1 错误错误，或者更具体地说是服务错误，定义为因客户端向服务传递错误数据，导致服务端拒绝该请求。...示例包括无效凭证、错误的参数、未知的版本ID等。客户端传递错误的或者不合法的数据的情况通常返回 “4XX” 的 HTTP 错误代码。错误不会影响API的整体可用性。...客户端指导为确保客户端更好的接入REST服务，客户端应遵循以下最佳实践: 6.1 忽略规则对于松散耦合的客户端调用，在调用之前不知道数据的确切定义和格式，如果服务器没用返回客户端预期的内容，客户端必须安全地忽略它...例如，以下内容是可以接受的(URL中，url参数传递了花式的鞋子这个资源): https://api.contoso.com/v1.0/items?

4.5K1 0

WordPress REST API 内容注入漏洞分析

漏洞简介在REST API自动包含在Wordpress4.7以上的版本，WordPress REST API提供了一组易于使用的HTTP端点，可以使用户以简单的JSON格式访问网站的数据，包括用户，帖子...控制器 WP-API中采用了控制器概念，为表示自愿端点的类提供了标准模式，所有资源端点都扩展WP_REST_Controller来保证其实现通用方法。...这个路由有三个端点： GET触发一个get_item方法，将post数据返回给客户端。 PUT触发一个update_item方法，使数据更新，并返回更新的发布数据。...根据上面的信息，我们可以知道这是注册controller对象的路由，实现路由中端点方法。在这里，如果我们向/wp-json/wp/v2/posts/1发送请求，则ID参数将被设置为1： ?...在这边将ID参数装换为一个整数，然后传递给get_post。而PHP类型转换的时候回出现这样的情况： ? 所以，也就是说，当攻击者发起/wp-json/wp/v2/posts/1?

3.1K7 0

4种主流的API架构风格对比

该 API 描述语言定义了端点并描述了可以执行的所有过程。这使得不同的编程语言和 IDE 能够快速建立通信。 SOAP 支持有状态和无状态消息传递。...（以动词为中心的 RPC 模型和以名词为中心的 REST 模型中的操作对比）在 REST 中，使用例如 GET、POST、PUT、DELETE、OPTIONS 可能还有 PATCH 等 HTTP 方法来完成操作...这使得 REST 在理论上很简单，但在实践中却很困难。庞大的负载：REST 会返回大量丰富的元数据，以便客户端可以仅从响应中了解有关应用程序状态的所有必要信息。...REST 的响应包含的数据会过多或不足，通常会导致客户端需要发送另一个请求。 4 REST 的用例管理 API。在系统中，专注于管理对象并面向许多使用者的 API 是最常见的 API 类型。...通过将客户端指向 GraphQL API，我们可以发现什么查询语句是可用的。没有版本控制：版本控制的最佳实践是不要对 API 进行版本控制。

2.3K3 0

解释 RESTful API，以及如何使用它构建 web 应用程序。【极狐低代码】【PUSDN】【GeeFox】

REST是一种架构模式，用于设计网络应用程序，它通过使用HTTP协议中的标准方法（如GET、POST、PUT、DELETE）来访问和操作资源。...RESTful API将应用程序的功能和数据以资源的形式暴露给客户端。客户端可以使用HTTP方法和URL来请求不同的资源操作（例如读取、创建、更新、删除）。...使用RESTful API构建web应用程序的过程如下：定义资源：确定应用程序中的资源，并将其建模为RESTful API的端点。每个资源都有唯一的URL（称为URI）和对应的HTTP方法。...处理请求和响应：使用服务器端编程语言（如Python、Java、Node.js）编写代码以处理客户端请求，并返回适当的响应。可以根据请求中的URL、HTTP方法和其他参数来执行不同的操作。...通过遵循RESTful API设计原则和最佳实践，可以构建出可扩展、易于维护和灵活的web应用程序。

970 0

独家 | 提升API设计技能的22个最佳实践（附链接）

作者：Mohammad Faisal翻译：张一然校对：和中华本文约2000字，建议阅读7分钟本文介绍了有关设计REST api的一些实用建议。...今天我们将讨论一些要遵循的最佳实践, 我们会保证文章简短易读-请系好安全带！.../health 使用 200 OK 状态代码响应对 /health 的请求。 /version 用版本号响应/version的请求。 /metrics 此端点将提供各种指标，例如平均响应时间。...获取字段查询参数考虑到要返回的数据量, 添加 fields 参数仅公开 API 中的必需字段。例子：仅返回商店的姓名，地址，和联系方式 GET /shops?...错误当客户端向服务器发出无效/不正确的请求，或者传输了无效/不正确的数据，而服务器拒绝该请求时，就会报错，具体来说是服务器错误。例如无效的身份验证凭据、错误的参数、未知的版本 ID 等。

5345 0

点击加载更多

扫码

添加站长进交流群

领取专属 10元无门槛券

手把手带您无忧上云