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

使用ASP.NET Core 3.x 构建 RESTful API - 2. 什么是RESTful API

JSON并不是REST强制的,甚至HTTP都不是REST强制使用的,但这也仅仅是从理论上来看。...在这里,组件之间的差异就是个迷,然后我们再一个挨一个的往里面添加约束并保证这些约束可以互不干扰、融洽相处。这些约束都定义了实现REST API的框架应该如何被构建和设计。...统一的资源接口/界面:Web组件之间的交互就意味着客户端、服务端以及基于网络的中介程序都依赖于它们接口的统一性(API和API的消费者之间共用相同标准的一套接口)。...通过表述来对资源进行操纵:REST的组件对资源的操作(CRUD)是通过首先获取该资源现有的表述或者目标表述,然后在组件之间完成从现有表述到目标表述的转换。...换句话说,超媒体会驱动如何消费和使用API,它会告诉API消费者使用这些API能做什么,例如:能删除这个资源吗?能修改资源吗?如何能创建这种资源?从哪能获取这个资源?

86810

REST API 最佳实践

客户端(前端)和服务器(后端)之间的通信通常不是超级直接的。因此,我们使用一个叫作“应用编程接口”(或 API)的接口,作为客户端和服务器之间的中介。...此外,搜索引擎也更喜欢使用连字符来分隔单词,使用连字符分隔单词,它们让搜索引擎更准确地理解 URL 中的单词和短语,这样搜索引擎就可以索引单个单词,有助于 SEO,很容易检索到这个 URL,排名靠前。...如一个使用连字符的 REST API URL 可能如下所示: https://api.example.com/users/john-doe 而使用下划线的 URL 则可能如下所示: https://api.example.com...16.提供准确的 API 文档 当你创建 REST API 时,你需要帮助用户(消费者)正确学习并了解如何使用它。最好的方法是为 API 提供良好的文档。...这将保护你的 API,使其更不容易受到恶意攻击。 你还应考虑其他安全措施,包括:使服务器和客户端之间的通信保密,确保使用 API 的任何人不会获得他们请求的以外的数据。

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

    grpc-swift入门

    不想看前面的屁话,要直接上代码的,请跳到「iOS App端如何实现和RPC服务器通信」章节 什么是RPC、gRPC、grpc-swift 要搞清楚什么是grpc-swift, 就要先搞清楚什么是gRPC...如下图: RPC的数据传输过程 截图出处: Comparing web API types: SOAP, REST, GraphQL and RPC What is gRPC OK,RPC是一种传输数据的方式...所以,数据包的size,比JSON小很多(想象一个例子:一个55bytes,一个20bytes)。 另外,二进制形式的数据包,CPU可以更高效地进行「序列化」和「反序列化」。...iOS App端如何实现和RPC服务器通信 好了,上面讲了一大堆屁话,终于到正题了。 要写一个iOS的App,和gRPC后台通信。首先,我们要有一个gRPC后台——好一句废话。...这样就完成gRPC「客户端」和「服务器」之间的数据传输了。 Are you kidding me? 就这几行代码?你写了3000字? OK,别着急,后面再写进阶一点的内容。

    1.8K20

    深度探索:前端中的后端

    这个模型很像客户端和服务器之间的通讯,客户端和服务器约定好服务的接口(REST API),客户端传递参数调用服务,服务端返回调用结果,在通讯链路上传递的数据是双方都支持的 JSON 格式。...那位问了:人家 REST/GraphQL API 不都是用 JSON 做序列化么?为啥这个场景使用就有问题呢?...比如为 get_movies() 获取到的数据做简单的索引,方便数据在各个不同维度的展示和过滤。 如何维护这样的「后端」代码?...语言本身的能力之外,第三方库的效率如何?Benedikt benchmark 了 Rust 和 Swift 对 JSON 数据的处理: ? 二者有 17 倍的性能差距。...所以,如果用 Rust 作为客户端来处理 REST API,每次 API 的请求能够节省大量的时间,尤其是很大的 JSON response。

    2.2K20

    Ceph RGW整体结构,最全干货在这!

    对于RGW而言,S3和Swift两个接口类型可以使用同一个存储空间(如.rgw.data),因此,可以使用两种接口对Object数据进行读写。...uri和method等rest请求信息(包含在RGWProcessEnv) 4、获取到相应的RGWOp和RGWHandler_Rest 5、然后由Scheduler调度某个Thread来执行相应Handler...重点讨论) Swift (对接Openstack的API) Swift Auth (Swift的授权认证API) Admin (提供Admin的API访问,例如创建user等操作) 每个API类型对应一个主...在RGW的启动过程中,可以使用g_conf来获取相应的参数,该方法通过ConfigProxy的方式来进行配置的获取和修改,其中ConfigProxy中采用Seastar来进行实现。...,如下是不同的类型对应的验证方法: 1、S3 API:RGWHandler_REST_S3::authorize 2、Swift API:RGWHandler_REST_SWIFT::authorize

    10.1K85

    关于 REST API 六大指导原则,你了解多少?

    API 使用者应该使用这些表示来修改服务器中的资源状态。...而资源的表现形式则是指资源的具体表现形式,比如文本可以是 HTML、XML、JSON 等格式,图片可以是 JPEG、PNG 等格式。客户端可以通过请求不同的表现形式来获取资源的不同表现形式。...这种方式使得客户端和服务器之间的通信更加灵活和可扩展。 自描述消息(Self-descriptive Messages):每个资源应该携带足够的信息来描述如何处理消息。...这意味着客户端可以根据服务器返回的超媒体链接来决定下一步要采取的操作,而无需事先了解服务器的 API 或其他约定。...这种方式可以使客户端和服务器之间的耦合更加松散,从而提高系统的可重用性和可扩展性。 总结 简而言之,在 REST 架构风格中,数据和功能被视为资源,并使用统一资源标识符 (URI) 进行访问。

    34110

    2.2接收数据

    另外, HTTP 协议还准备了 OSS 的框架,方便人们使用。 REST API 设备应该如何访问物联网服务呢?...在 Web 服务的世界里,有一种思路叫作 RESTful。REST 是一 种接口,它为特定的 URL 指定参数并执行访问,作为其响应来 获取结果。...MQTT 里存在 3 个等级的 QoS。“发布者和中介之间”以及“中介和订阅者之间”都分别定义了不同的 QoS 等级,以异步的方式运行。...此外,当“中介与订阅者之间”指定的 QoS 小于“发布者和中介之间”交换的 QoS 时,“中介与订阅者之间”的 QoS会被降级到指定的 QoS。...图 2.18 用 XML 和 JSON 分别表示了两台传感器的信息、设备的状态、获取数据的时间,以及发送数据的设备名称等。 比较二者可知, XML 的格式比 JSON 更容易理解。

    2.9K30

    微服务原则:去中心化数据管理

    REST 的思想 为了以去中心化的方式正确地组织数据,首先要了解如何使用表述性状态转移(Representational State Transfer,简称 REST)对数据建模。...使用我们定义的基础 REST API,客户端需要进行多次 API 调用才能填充此视图。例如,有两位朋友的用户,客户端需要发出以下 API 请求才能填充视图: 4.png 总共会发出五个请求。...用于实现这种新资源的技术,是集中式和去中心化数据管理之间差异的一个主要例子。...此外,数据如何存储,以及数据如何被操作以供用户显示,两者之间的分离使得底层微服务可以被重构,只要它们继续遵循时间轴服务所期望的资源格式。...对于社交消息传递应用程序的例子,每条消息实际上是一个结构化的 JSON 文档,其中包含了媒体文件、地理位置等元数据。此外可以预期的是,将会有许多用户发布消息,并且需要保留的消息总数将迅速增长。

    3.6K40

    宜家IKEA EDI项目案例

    但在ECIS和供应商的内部业务系统(如:ERP系统、SAP系统)之间出现大量的手工重复操作,无法对业务数据进行自动化处理。供应商可以选择 EDI 对接来改善以上问题。...使用EDI的主要目的是为加快信息流传输,提高业务流程的自动化。通过自动化和标准化的订单流程,降低了订单管理成本、减少了大量人工重复操作,且有效地提高了数据处理效率。...EDI解决方案C公司使用的是用友ERP,经与用友ERP供应商沟通,最终达成一致,通过互相调用REST API方式实现EDI 与用友ERP的无缝集成。...数据接收: EDI系统收到来自宜家IKEA的数据后,主动调用用友ERP的REST API接口,通过Json形式进行数据推送;数据发送:用友ERP主动调用知行EDI系统 REST API接口,通过Json...知行EDI顾问: 基于知行EDI系统,搭建工作流,实现EDIFACT 与Json的格式转换;用友ERP顾问:开发REST API结构,以便后期做EDI与用友ERP联调测试。

    78020

    我为什么要放弃RESTful,选择拥抱GraphQL

    REST 的 API 配合JSON格式的数据交换,使得前后端分离、数据交互变得非常容易,而且也已经成为了目前Web领域最受欢迎的软件架构设计模式。...但随着REST API的流行和发展,它的缺点也暴露了出来: 滥用REST接口,导致大量相似度很高(具有重复性)的API越来越冗余。...先看REST API的做法: REST API获取数据 再来看GraphQL是怎么做的: GraphQL获取数据 可以看出其中的区别: 与REST多个endpoint不同,每一个的 GraphQL...GraphQL 思考模式 使用GraphQL接口设计获取数据需要三步: GraphQL获取数据三步骤 首先要设计数据模型,用来描述数据对象,它的作用可以看做是VO,用于告知GraphQL如何来描述定义的数据...GraphQL特点总结 声明式数据获取(可以对API进行查询): 声明式的数据查询带来了接口的精确返回,服务器会按数据查询的格式返回同样结构的 JSON 数据、真正照顾了客户端的灵活性。

    3K40

    GraphQL

    REST 的 API 配合JSON格式的数据交换,使得前后端分离、数据交互变得非常容易,而且也已经成为了目前Web领域最受欢迎的软件架构设计模式。...但随着REST API的流行和发展,它的缺点也暴露了出来: 滥用REST接口,导致大量相似度很高(具有重复性)的API越来越冗余。...先看REST API的做法: REST API获取数据 再来看GraphQL是怎么做的: GraphQL获取数据 可以看出其中的区别: 与REST多个endpoint不同,每一个的 GraphQL 服务其实对外只提供了一个用于调用内部接口的端点...GraphQL 思考模式 使用GraphQL接口设计获取数据需要三步: GraphQL获取数据三步骤 首先要设计数据模型,用来描述数据对象,它的作用可以看做是VO,用于告知GraphQL如何来描述定义的数据...GraphQL特点总结 声明式数据获取(可以对API进行查询): 声明式的数据查询带来了接口的精确返回,服务器会按数据查询的格式返回同样结构的 JSON 数据、真正照顾了客户端的灵活性。

    3.2K65

    为什么我劝你放弃了Restful API?

    REST 的 API 配合JSON格式的数据交换,使得前后端分离、数据交互变得非常容易,而且也已经成为了目前Web领域最受欢迎的软件架构设计模式。...但随着REST API的流行和发展,它的缺点也暴露了出来: 滥用REST接口,导致大量相似度很高(具有重复性)的API越来越冗余。...GraphQL 思考模式 使用GraphQL接口设计获取数据需要三步: 首先要设计数据模型,用来描述数据对象,它的作用可以看做是VO,用于告知GraphQL如何来描述定义的数据,为下一步查询返回做准备;...新的开发需求可以直接就使用GraphQL服务来获取数据了,以前已经上线的功能无需改动,还是使用原有请求调用REST接口的方式,最低程度的降低更换GraphQL带来的技术成本问题!...GraphQL特点总结 声明式数据获取(可以对API进行查询): 声明式的数据查询带来了接口的精确返回,服务器会按数据查询的格式返回同样结构的 JSON 数据、真正照顾了客户端的灵活性。

    3.8K20

    从 API 设计开始,了解一下 Golang 的新框架 Twirp

    此外,我们不想给我们的数据库带来太多压力,所以我们在 stats api 和 stats writer 之间放了一个队列,它会以 10 个项目为一组写入数据库。...开发人员和架构师选择 RESTful API 作为服务之间的通信方式是很常见的,但我想解释为什么 REST 可能是我实在没办法才会考虑的选项之一。 REST 当今最常见的 API 实现是 REST。...REST API 有一个统一的接口,允许应用程序独立演进,而无需应用程序的服务或模型和动作与 API 层本身紧密耦合。...JSON JSON 是迄今为止最流行的 REST API 数据格式,但它有几个限制: 没有模式(schema):我们的数据库有模式,我们的代码编写的时候就保留了一种模式,那么为什么我们的数据格式没有模式呢...为了对比 Twirp 和 REST,我编写了这个基础应用程序,可以通过 RPC 和 REST 发送 / 检索玩家统计数据。 REST 实现很简单,可以在这里找到,我们就跳过它直接来看 twirp。

    95530

    为什么我使用 GraphQL 而放弃 REST API?

    至此,我再也无法回过头来享受使用 REST 的工作了。 REST 有什么问题吗? 每个 REST API 都是独特的 公平地说,REST 甚至不是一个标准。...你可能会说你的 API 是 RESTful 的,但是对于如何安排端点或是否应该(例如)使用 HTTP 方法PATCH进行对象更新,一般没有严格的规则。...参见 GitHub REST API(至少不是在头中传递 JSON)。 说到过滤,就有趣多了……需要按一个字段过滤吗?没问题,可能是/todos?...如果开发团队不是全栈的,那么服务器和客户端团队之间的沟通就至关重要,在没有机器可读的 API 规范的情况下更是如此。 GraphQL 如何做得更好?...要了解这些工具是如何工作的,请查看 Star Wars API 示例,它可以作为 GraphiQL 的在线演示。 能指定从服务器请求的对象字段让客户端可以根据需要只获取需要的数据。

    3.3K30

    3、进程间通信

    之后,Trip Management 服务创建路线,并使用发布/订阅通知其他服务,包括用于定位可用司机的 Dispatcher。 现在我们来看一下交互方式,我们先来看看如何定义 API。...3.3、定义 API 服务 API 是服务与客户端之间的契约。...服务使用点对点通道,就是上述的一对一交互方式。 发布订阅通道将每条消息传递给所有已订阅的消费者。服务使用发布订阅通道,就是上述的一对多交互方式。 图 3-4 展示了打车应用程序如何使用发布订阅通道。...3.8.1、REST 如今,开发 RESTful 风格的 API 是很流行的。REST 是一种使用了 HTTP (几乎总是)的 IPC 机制。...3.10、总结 微服务必须使用进程间通信机制进行通信。在设计服务如何进行通信时,您需要考虑各种问题:服务如何交互、如何为每个服务指定 API、如何演变 API 以及如何处理局部故障。

    1.7K20

    微服务架构中的进程间通信

    现在我们来看看交互风格,我们来看看如何定义API。 定义API 服务的API是服务和客户之间的合同。无论您选择IPC机制,重要的是使用某种接口定义语言(IDL)精确定义服务的API。...发布订阅频道将每条消息传递给所有附加的消费者。服务使用发布订阅渠道进行上述的一对多的交互风格。 下图显示了出租车应用程序如何使用发布订阅频道。 ?...两种流行协议是REST和Thrift。我们先来看一下REST。 REST 今天开发REST风格的API是时尚的。 REST是一种(几乎总是使用HTTP)的IPC机制。...例如,客户端可以使用响应于发送的GET请求返回的订单表示中的链接来取消订单以检索订单。 HATEOAS的优点不再需要将网址硬编码到客户端代码中。...在设计您的服务如何通信时,您需要考虑各种问题:服务如何交互,如何为每个服务指定API,如何发展API以及如何处理部分故障。微服务器可以使用两种IPC机制,异步消息传递和同步请求/响应。

    3K50

    REST API URI的七大设计原则

    在了解REST API URI设计的规则之前,让我们快速浏览一些我们将要讨论的术语。 URIs REST API使用统一资源标识符(URI)来寻址资源。...,请使用连字符( - )字符来提高长路径中名称的可读性。...在路径中,应该使用连字符代空格连接两个单词 。...应鼓励REST API客户端使用HTTP提供的格式选择机制Accept request header。 为了是链接和调试更简单,REST API应该支持通过查询参数来支持媒体类型的选择。...URI的名称和结构应该能够向使用者传达更清晰的含义。通过遵循上述规则,您将创建一个更清晰的的REST API与更友好的客户端。这些并不是REST的规则或约束,仅仅是API的增强和补充。

    2.3K60

    REST API URI 设计的七准则

    在了解 REST API URI 设计的规则之前,让我们快速过一下我们将要讨论的一些术语。 URI REST API 使用统一资源标识符(URI)来寻址资源。...URI 容易被人检索和解释,请使用连字符( - )来提高长路径段中名称的可读性。...在任何你将使用英文的空格或连字号的地方,在URI中都应该使用连字符来替换。...为了实现简单的链接和调试的便捷,REST API 也可以通过查询参数来支持媒体类型的选择。 规则#7:端点名称是单数还是复数? 这里采用保持简单的原则。...URI 的名称和结构应该向消费者传达意义。通过遵循上述规则,你将创建一个更加清晰的 REST API。这不是一个 REST 规则或约束,而是增强了 API。

    1.9K40

    API架构风格对比:SOAP vs REST vs GraphQL vs RPC

    服务端存根(stub)和客户端存根(stub)负责参数的序列化和反序列化。 ? RPC的优点 直接简单的交互方式:RPC使用GET获取信息,并使用POST处理其他功能。...gRPC背后使用的是HTTP 2,因此能够优化网络层,每天可以在不同的服务间传送大量消息。但如果不关心高性能网络,转而期望团队间能够使用稳定的API来发布不同的微服务,那么可以选择使用REST。...高度安全的数据传输:SOAP的刚性结构、安全和授权能力使其特别适用于在遵守API提供者和API使用者之间的契约的同时,在API和客户端之间履行正式的软件契约。...作为当今最通用的API风格,它最初出现在2000年的Roy Fielding 的博士论文中。REST使用简单格式(通常是JSON和XML)来表达服务侧的数据。...过度获取和不足获取问题:由于有时候会出现包含的数据过多或过少的情况,导致在接收到REST的响应之后,通常还会需要另一个请求。

    3.7K11
    领券