首页
学习
活动
专区
圈层
工具
发布

Microsoft REST API指南

有关选项使用的示例,请参见完善CORS跨域调用。 7.5 标准的请求标头 下面的请求标头表 应该遵循 Microsoft REST API指南服务使用。...使用这些标题不是强制性的,但如果使用它们则必须始终一致地使用。 所有标头值都必须遵循规范中规定的标头字段所规定的语法规则。...与If-Match、If-None-Match和If-Range一起使用,实现乐观并发控制。| 7.7. 自定义标头 基本的API操作不应该支持自定义标头。...本文档中的一些准则规定了非标准HTTP标头的使用。此外,某些服务可能需要添加额外的功能,这些功能通过HTTP标头文件公开。以下准则有助于在使用自定义标头时保持一致性。...如果请求中存在Origin标头: 添加一个Access-Control-Allow-Headers响应标头,其中包含允许客户端使用的请求标头名称列表。

6.1K11

什么是RESTful,REST api设计时应该遵守什么样的规则?

如何使用REST API?HTTP 动词REST API 通过各种 HTTP 请求方法,使前端与服务器的通信过程更容易,最常用的方法是:GET : 用于读取服务器上的数据。POST : 用于创建数据。...id为1的用户信息:https://www.wljslmz.cn/v1/users/15、URL分页分页可以轻松处理大量请求结果,例如,Web 服务包含数百或数千个页面,当请求显示其所有页面时,将获得相同数量的结果作为回应...limit=106、使用连字符增加可读性最好用连字符-,而不是_或者驼峰,在所有 RESTful API 中,连字符等同于空格。...:错误请求(客户端应修改请求)401:未经授权,凭据无法识别403:禁止,凭据接受但没有权限404:未找到,资源不存在410:消失了,资源以前存在但现在不存在429:请求过多,用于速率限制,应包含重试标头...500:服务器错误,一般性,值得查看其他 500 级错误503:服务不可用,另一个重试标头有用总结REST是一种软件架构风格,用于 Web 架构的设计,任何遵循 REST 设计原则的 API都被称为 RESTful

1.4K30
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    【API架构】REST API 设计的原则和最佳实践

    这是一个完整的图表,可以轻松理解 REST API 的原理、方法和最佳实践。 现在,让我们从每个盒子的原理开始详细说明它。...超媒体作为应用程序状态引擎 (HATEOAS):客户端通过正文内容、查询字符串参数、请求标头和请求的 URI(资源名称)传递状态。服务通过正文内容、响应代码和响应头向客户端提供状态。...服务通过在响应(如 Cache-Control、Expires、Pragma、Last-Modified 等)上设置标头来提高缓存能力 分页:REST 的原则之一是连通性——通过超媒体链接。...当链接在响应中返回时,API 变得更具自我描述性。对于支持分页的响应中返回的集合,“first”、“last”、“next”和“prev”链接至少是有益的。...资源命名:当资源命名正确时,API 是直观且易于使用的。做得不好,同样的 API 会让人感觉很笨拙,并且难以使用和理解。RESTful API 适用于消费者。

    2K10

    8.寻光集后台管理系统-用户管理(增删改查)

    请求未成功通过身份验证,最高优先级的身份验证类不使用WWW-Authenticate标头。— 将返回 HTTP 403 Forbidden 响应。...请求的身份验证没有成功,并且最高优先级的身份验证类确实使用了WWW-Authenticate头。一个HTTP 401未经授权的响应,将返回一个适当的WWW-Authenticate报头。...] 或者使用基于装饰器@api_view的函数视图 from rest_framework.decorators import api_view, permission_classes from rest_framework.permissions...REST framework已经实现了分页api。它支持: 将分页的链接作为响应内容的一部分,这是默认的方案。 响应头中包含分页链接,如Content-Range或Link。...注意只有在使用通用视图或视图集时,分页才会自动执行。如果你使用一个常规的APIView,你需要自己调用分页API来确保你返回一个分页的响应。

    2.4K30

    Spring认证中国教育管理中心-Spring Data REST框架教程二

    POST 该POST方法从给定的请求正文创建一个新实体。默认情况下,响应是否包含正文由Accept随请求发送的标头控制。如果发送了一个,则会创建一个响应正文。...默认情况下,响应是否包含正文由Accept随请求发送的标头控制。如果请求标头存在,200 OK则返回响应正文和状态代码。...如果不存在标头,则响应正文为空,并且成功的请求将返回 状态204 No Content。...分页和排序 本节记录了 Spring Data REST 对 Spring Data Repository 分页和排序抽象的使用。...5.1.分页 Spring Data REST 不是从大型结果集中返回所有内容,而是识别一些影响页面大小和起始页码的 URL 参数。

    2.4K10

    在 REST 服务中支持 CORS

    重要提示:默认 CORS 标头处理不适用于处理机密数据的 REST 服务。接受 CORS 标头要指定 REST 服务接受 CORS 标头:修改规范类以包含 HandleCorsRequest 参数。...最终结果是调度类从自定义类而不是从 %CSP.REST 继承,因此使用对 OnHandleCorsRequest() 的定义,它覆盖了默认的 CORS 标头处理。...还需要知道如何检查请求并设置响应标头。为此,检查默认使用的方法是有用的,即 %CSP.REST 的 HandleDefaultCorsRequest() 方法。...本节说明此方法如何处理源、凭据、标头和请求方法并提出变体建议。可以使用此信息来编写 OnHandleCorsRequest() 方法。以下代码获取源并使用它来设置响应标头。...代码应测试是否允许标头和请求方法。如果允许,请使用它们来设置响应标头。如果不是,请将响应标头设置为空字符串。

    3.5K30

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

    在我的职业生涯中有很大一部分时间都参与了构建、设计和使用API 的项目。我见过的大多数API 都“声称” 是 “符合REST原则”的——意味着遵循 REST 架构的原则和约束。...不要返回纯文本 尽管并非强制规定的,但大多数REST API通常约定使用JSON作为数据格式。然而,仅返回包含JSON格式字符串的响应体是不够好的。您还应该指定Content-Type标头。...在处理应用程序/编程客户端(例如,通过Python中的requests库与您的API交互的另一个服务/API)时,这一点尤为重要——其中一些客户端依赖于此标头来准确解码响应。 3....分页允许用户逐步获取数据集。最简单类型的分页就是按页码进行分页,它由page和page size确定。现在问题来了:如何将这样的功能融入REST API?...我的答案是:使用查询字符串(querystring)。 我认为使用查询字符串实现分页非常明显。它看起来像这样: GET: /books?

    2K40

    REST API设计指导——译自Microsoft REST API Guidelines(四)

    表的请求头应该遵循微软REST API服务规范。使用这些标头不是必须的,但是如果用到,那么它们必须使用一致。...PS:通过将Prefer标头设置可以省略响应正文。如果Prefer标头设置为return-no-content,则服务将使用状态代码204(No Content)和响应标头进行响应。...基本的API操作禁止定义自定义标头。...本文档中的一些准则规定了使用非标准HTTP标头。 此外,某些服务可能需要添加额外的功能,这些功能通过HTTP标头公开。 以下准则有助于保持自定义标头使用的一致性。...这个规则的一个例外是Accept标头。通常使用具有简单名称的方案,而不是使用HTTP规范中描述的Accept的完整功能。 7.9.

    2.9K50

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

    简介 REST 是一种软件架构风格,它依赖于描述如何定义和访问资源的规则。很难想象没有RESTful API的现代互联网。在本文中,我们将深入探讨 REST 和相关 HTTP 概念。 2....REST 架构 正如我们提到的,REST是一种软件架构风格。另一方面,它不是标准化的(如SOAP)。它在实施方面提供了很大的弹性。例如,没有单一且适当的方法来实现分页。...该请求包括: 包含路径、协议版本和 HTTP 方法的请求行 零个或多个标头 指示标头结尾的空行 可选主体 3.1. 方法 我们已经知道,HTTP 请求由请求行和 HTTP 方法组成。...还有其他方法,有时可以使用:补丁,头,选项,连接和跟踪。虽然,很少使用,我们不会在本文中介绍它们。 3.2. 代码 HTTP 响应附带响应代码。它通知操作的结果。...因此,它表明考虑到 REST 约束,API 的质量很好。 0级被称为痘沼泽。在这个层面上,API并没有使用HTTP协议的全部潜力,通常,它只使用POST和GET方法。因此,HTTP 协议仅用作传输层。

    27410

    【愚公系列】2022年04月 Python教学课程 76-DRF框架之分页

    分页 API 可以支持以下任一功能: 作为响应内容的一部分提供的分页链接。 响应标头中包含的分页链接。 内置样式目前都使用作为响应内容的一部分包含的链接。使用可浏览 API 时,此样式更易于访问。...仅当您使用通用视图或视图集时,才会自动执行分页。如果您使用的是常规 ,则需要自己调用分页 API,以确保返回分页响应。有关示例,请参阅 和 类的源代码。 可以通过将分页类设置为 来关闭分页。...您还可以使用该属性在单个视图上设置分页类。通常,您需要在整个 API 中使用相同的分页样式,但您可能希望根据每个视图改变分页的各个方面,例如默认或最大页面大小。...None template- 在可浏览 API 中呈现分页控件时要使用的模板的名称。可以重写以修改呈现样式,或设置为完全禁用 HTML 分页控件。缺省值为 。...ordering = ‘slug’-createdOrderingFilter template= 在可浏览 API 中呈现分页控件时要使用的模板的名称。

    1.2K20

    API自动化测试指南

    Cookies是存储在客户端上的文件,具有从HTTP标头信息中添加的信息。当向用户已经访问过的网站发出请求时,存储在Cookies中的信息将发送回浏览器。...选项 –询问有关服务器上可用选项的信息 HEAD –与GET请求类似,但仅发送有关文档的信息 CONNECT –客户端必须使用HTTPS服务器时使用 标头 包含要发送到服务器的其他信息,例如浏览器,操作系统...标头的不同类型是: 常规 -可选的标头,其中包含诸如当前时间之类的信息 请求 -向服务器提供有关客户端的更多信息 实体 -包含有关发送文档的特定信息,例如长度和编码方案。...从服务器返回的响应也包含三个部分,就像我们在HTTP请求中看到的那样: 响应行(状态码) 标头信息 包含响应中所有文本的正文 HTTP状态码 在我们的示例中,状态代码为200,表示一切正常。...URI语法允许您指定一个查询,该查询从REST API返回所需的信息。REST系统的主要元素是: 资源是客户端请求从主机获取的信息,例如网页或数据库记录。 资源标识符是用于命名资源的URI。

    2.2K00

    15款Django开发常用软件包 原

    我们这里整理了15款Django开发中常用的软件包,学会使用它们可以节省大量开发时间,提高开发效率。同时,也给出了它们的pip安装方法。下面一起来看下。  一、认证和授权  1....Django OAuth Toolkit 可以帮助Django项目实现数据、逻辑的OAuth2功能,可与Django REST框架完美整合起来。  ...Django REST 框架 构建REST API的优秀框架,可管理内容协商、序列化、分页等,开发者可以在浏览器中浏览构建的API。  ...8. django-cors-headers 一款设置CORS(Cross-Origin Resource Sharing)标头的应用,基于XmlHttpRequest,对管理Django应用中的跨域请求非常有帮助...可结合库“python-boto”一起使用,将静态文件存储到Amazon S3上。   pip install django-storages 11.

    2.6K20

    如何测量并报告ASP.NET Core Web API请求的响应时间

    在本文中,我们将了解如何使用代码来测量API的响应时间,然后将响应时间数据返回到客户端。...让我们探索一些方法来捕获API的响应时间,主要集中在捕获API中花费的时间。我们的目标是计算从Asp.net Core运行时接收请求到处理响应并从服务器返回结果所经过的时间(以毫秒为单位)。...使用响应头将响应时间信息发送到使用我们的Rest API的客户端应用程序。 可能还有其他有用的方法来使用响应时间数据。您可以在评论区进行留言,并告诉我您是如何处理应用程序中的响应时间数据的。...public class ResponseTimeMiddleware { // Name of the Response Header, Custom Headers starts with "X-...我们使用X-Response-Time-ms标头作为响应标头。作为惯例,自定义标题以X开头。 总结 在本文中,我们了解了如何利用ASP.NET中间件来管理跨领域问题,例如测量API的响应时间。

    2.5K10
    领券