REST API规范位置？ - 腾讯云开发者社区

文章/答案/技术大牛

发布

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

RESTful API 背后的思想是遵循REST 规范中描述的所有架构规则和限制的方式进行开发。然而，实际上，这在实践中基本上是不可能的。一方面，REST 包含了太多模糊和模棱两可的定义。...REST API 规范能做什么? 尽管存在上面说到的缺点，但使用合理的方法，REST 仍然是创建真正优秀 api 的一个绝佳选择。...因为你通过高质量的 API 规范实现的 api 将会是一致的，具有清晰的结构、良好的文档和高的单元测试覆盖率。通常，REST API规范与其文档相关联。...OpenAPI 规范 OpenAPI 是目前最广泛接受的 REST API 规范格式。...如果你想让你的 REST API 更具规范，不妨试试文中提到的。

3.5K2 1

一个简约可行的 REST API 规范

后台接口一般以 REST API 形式对外提供服务，为了提升接口可维护性与使用者的体验，公司或团队应制定对外接口的统一规范。...此外，规范化的接口设计可以提高软件的可扩展性和可维护性，减少代码冗余和开发时间。 2.接口设计 URL 设计用 HTTP 方法操作资源。...GET https://api.example.com/favorite-teachers?...DB 更新失败 10006 DB 查询失败 10007 DB 删除失败 10008 JSON 序列化失败 10009 JSON 反序列化失败参考文献 Google JSON Style Guide REST...API 最佳实践_恋喵大鲤鱼的博客

6835 0

您找到你想要的搜索结果了吗？

是的

没有找到

用ASP.NET Core 2.1 建立规范的 REST API -- 保护API和其它

本文介绍如何保护API，无需看前边文章也能明白吧。...但是它主要用于包含页面的web应用, 例如MVC或Razor Page, 并不适用于REST/Web API, 所以不介绍它了....我一直在用Identity Server 4, 但是这里不会深入介绍, 这里主要介绍如何实现REST API, 如果有需要的话, 可以写一系列关于Identity Server 4的文章....这样就可以保护API，避免一些非正常使用的场景，例如网络爬虫或请求太多而导致API的性能严重下降，Dos和DDos。...接下来要在管道里添加中间件，它应该放在靠前的位置，在日志和异常之后： ? 测试，发送一个请求看结果： ? 可以看到5分钟内还剩下两次请求的配额。限制重置的时间大约在5分钟之后。

2K2 0

用ASP.NET Core 2.1 建立规范的 REST API -- HATEOAS

项目开始提升到Richardson成熟度3级的高度，尽管暂时还没有实现REST所有的约束，但是已经比较RESTful了。...201806/986268-20180608085054518-398664058.jpg HATEOAS（Hypermedia as the engine of application state）是 REST...架构风格中最复杂的约束，也是构建成熟 REST 服务的核心。...它的重要性在于打破了客户端和服务器之间严格的契约，使得客户端可以更加智能和自适应，而 REST 服务本身的演化和更新也变得更加容易。...根文档 RESTful的API需要为API的消费者提供一个根文档。通过这个文档，API消费者可以知道如何与其余的API进行交互。可以把这个理解为索引页面吧。

1.5K4 0

Rest api简介

并且，过多的参数会导致 URL 的可读性变差，更有甚者，可能会导致 URL 过长，超出规范，API 请求无法执行。更为标准的内容协商方式是使用 HTTP 头。...201 是否只显示处于警告状态的应用实例 301 重定向 , 请求的网页已被永久移动到新位置。服务器返回此响应时，会自动将请求者转到新位置。...302 重定向 , 请求的网页临时移动到新位置，但求者应继续使用原有位置来进行以后的请求。302 会自动将请求者转到不同的临时位置。 304 未修改，自从上次请求后，请求的网页未被修改过。...使用 HTTP 头进行缓存处理在 REST 的构架中，我们除了在与后台的数据交换中，需要有一个良好的缓存机制外，针对 REST API 请求都是在远端用 HTTP 发起这一特点，还需要为网络缓存进行更多考虑...文档服务：是否由于 API 持续更新，使得客户端连接不同版本服务的时候疲于奔命？尝试着把你的 API 定义规范成 XML 文档，这样客户端很容易理解当前服务可以提供哪些功能，以及如何使用这些功能。

3.5K6 0

Elasticsearch：REST API

Elasticsearch 里的接口都是通过 REST 接口来实现的。 Index PUT twitter/_doc/1?...ES 也提供了相应的 REST 接口。...ES 也提供了相应的 REST 接口。...来进行更新一个文档： POST _bulk { "update" : { "_index" : "twitter", "_id": 2 }} {"doc": { "city": "长沙"}} 注意：通过 bulk API

2.4K0 0

用ASP.NET Core 2.0 建立规范的 REST API -- 预备知识

什么是REST REST 是 Representational State Transfer 的缩写....在RPC的世界里, 节点仅仅就是可以在远程被触发的函数, 而在REST的世界里, 节点就是实体, 也叫做资源....REST的原则/约束 REST有6大原则/约束, 每一个原则都是对API有正面或负面影响的设计决定....RESTful API 最关心的有这几方面: 性能, 可扩展性, 简洁性, 互操作性, 通讯可见性, 组件便携性和可靠性. 这些方面被封装在REST的6个原则里, 它们是: 1....分层系统: 就像其它的软件架构一样, REST也需要分层结构, 但是不允许某层直接访问不相邻的层. 4.

2.6K0 0

REST API设计指导——译自Microsoft REST API Guidelines（二）

同时，我们推荐将此规范作为团队的REST API设计指导和规范。...本文档建立了 Microsoft REST API 开发人员应该遵循的指南, 以便统一一致地开发 API。...一致性的好处在于可以不断地积累合理的规范;一致性使团队拥有统一的代码、模式、文档风格和设计策略。...HTTP/1.1 语义规范的权威资料。关于 REST 的入门书籍。译者注：上一篇说了，REST 指的是一组架构约束条件和原则。...显然，实现或必须与某些外部定义的 REST API 互操作的 REST 服务必须与那些 API 兼容，而无法遵循这些准则。

2.1K1 0

REST API设计指导——译自Microsoft REST API Guidelines（一）

如果API的设计更规范更合理，在很大程度上能够提高联调的效率，降低沟通成本。那么什么是好的API设计？这里我们不得不提到REST API。...另外，REST API的书籍很多，但是完整完善实践丰富的设计指导并不多见，我们有幸看到了微软团队的作品——Microsoft REST API Guidelines，因此才有了此篇内容。...简单的来说，在REST API:URL定位资源，用HTTP动词（GET,POST,PUT,DELETE)描述操作。前面说了，REST 指的是一组架构约束条件和原则。...为什么用REST API? 1.前后端分离主要以API为界做接洽的，这样就会有很多的API，API的表现力更强，更加便于理解。...2.REST API没有状态，不管前端是何种状态何种设备下都可以无差别的请求资源。 3.Restful API有直接的规范和原则。简单的来说，有以下好处：看到Url就知道可以拿到什么。

2.3K3 0

REST API设计指导——译自Microsoft REST API Guidelines（四）

前言前面我们说了，如果API的设计更规范更合理，在很大程度上能够提高联调的效率，降低沟通成本。那么什么是好的API设计？这里我们不得不提到REST API。...关于REST API的书籍很多，但是完整完善实践丰富的设计指导并不多见，我们有幸看到了微软团队的作品——Microsoft REST API Guidelines，因此才有了此篇内容。...上篇内容： REST API设计指导——译自Microsoft REST API Guidelines（三） 6 Client guidance 客户指导 To ensure the best possible...符合 Microsoft REST API 指南的 API 应该支持 PATCH 方法。...表的请求头应该遵循微软REST API服务规范。使用这些标头不是必须的，但是如果用到，那么它们必须使用一致。

3.7K5 0

REST API设计指导——译自Microsoft REST API Guidelines（三）

前面我们说了，如果API的设计更规范更合理，在很大程度上能够提高联调的效率，降低沟通成本。那么什么是好的API设计？这里我们不得不提到REST API。...关于REST API的书籍很多，但是完整完善实践丰富的设计指导并不多见，我们有幸看到了微软团队的作品——Microsoft REST API Guidelines，因此才有了此篇内容。...5 Taxonomy 分类 As part of onboarding to Microsoft REST API Guidelines, services MUST comply with the taxonomy...Microsoft REST API 准则基本要求的一方面就是服务的分类必须符合以下定义。...5.5 Long running API faults 长时间运行的API故障 For a Long Running API, it's possible for both the initial request

2.1K3 0

用ASP.NET Core 2.0 建立规范的 REST API -- GET 和 POST

资源 (Resource) 的命名指导规范首先, 资源应该使用名词, 它是个东西, 不是动作....例如: api/getusers 就是不正确的. GET api/users 就是正确的 GET api/users/{userId}. 所以资源应该使用的是名词....如果是非分层结构的资源, 那么它不应该这样命名: api/xxx/xxx/users, 而应该使用 api/users....如果是单个资源, 不应该这样 api/id/users, 而应该是 api/users/{userId}. (资源名是否复数还是根据个人习惯吧)....但是有时候, RPC风格的方法调用很难映射成规范的资源命名, 所以有时可以打破规范例如 api/users/{userId}/totalsalaries.

2.5K1 0

用ASP.NET Core 2.1 建立规范的 REST API -- 缓存和并发

后缀改为zip）：https://images2018.cnblogs.com/blog/986268/201806/986268-20180611132306164-388387828.jpg 缓存根据REST...更多指令请查看: https://tools.ietf.org/html/rfc7234#section-5.2 Cache Headers 根据REST的约束, 为了支持HTTP缓存, 我们需要一个可以生成正确的响应...但是悲观并发控制是无法在REST下实现的，因为REST有个无状态约束。...在REST里这是可以实现的，而这个Token就是个验证器，而且要求是强验证器，所以我们可以用ETag。回到例子: ? 客户1发送GET请求，返回响应并带着ETag Header。...本文比较短，一些关于缓存技术的内容并没有写，距离REST的主题有点远。

1K3 0

什么是REST API

什么是REST API？...API-Request.png REST API响应响应的有效负载可以是任何实用的东西：数据、HTML、图像、音频文件等等。...REST API挑战 REST的成功很大程度上归功于它的简单性。开发人员可以自由地实现RESTful API，但这可能会导致进一步的挑战。...REST API必须识别用户和他们的权利，但它可能不关心哪个应用程序在调用API。 REST API安全性 RESTful API提供了另一种访问和操作你的应用程序的途径。...REST API链接和开发工具有许多工具可以帮助所有语言的RESTful API开发。值得注意的选项包括： Swagger[20]：帮助设计、记录、模拟、测试和监控REST APIs的各种工具。

6.9K2 0

Yarn Rest Api使用

前言 Yarn Rest Api 返回的数据都是XML格式，需要解析XML。

3.9K3 0

Microsoft REST API指南

Microsoft REST API指南摘要 Microsoft REST API指南作为一种设计原则，鼓励应用程序开发人员通过RESTful HTTP接口访问资源。...允许Service开发者利用其他Service的基础上来开发一致的REST API端点。允许合作伙伴(例如,非Micosoft团队)使用这些准则来设计自己的 REST API。...REST论文—— Roy Fielding网络架构论文中关于REST的章节，“架构风格与基于网络的软件体系结构设计” RFC 7231—— 定义HTTP/1.1 语义规范的权威资源。...符合Microsoft REST API准则的API应该支持PATCH。 7.4.3....例如，以下请求: POST https://api.contoso.com/v1.0/people 会导致响应，指示新集合项的位置： 201 Created Location: https://api.contoso.com

7.2K1 1

Elasticsearch(二)——Rest API

RESTful 接口 URL 的格式是： http://cluster的地址: 9200/<index>I<type>I [<id>] 其中,index, ...

2K2 0

【Elasticsearch】Rest风格API

Rest风格API Elasticsearch提供了Rest风格的API，即http请求接口基本概念 Elasticsearch也是基于Lucene的全文检索库，本质也是存储数据，很多概念与MySQL

2K4 0

Storm UI REST API

简介 Storm UI 守护进程提供了 REST API, 允许我们与 Storm 集群进行交互, 其中包括查看指标数据，配置信息以及启动或停止拓扑的管理操作。...REST API 结果以 JSON 形式返回。 2....用法 REST API 是 Storm UI 守护进程（由 storm ui 启动）的一部分，因此与 Storm UI 守护进程在同一主机和端口上运行。...我们可以使用 curl 等工具来操作 REST API: # 请求集群配置 # 注意: 假设 ui.port 配置的为默认值 8080 $ curl http://:8080/api...topologyId": "wordcount-1-1420308665", "status": "succe" } 英译对照: host: 主机 Storm版本: 2.0.0 原文:Storm UI REST

2.9K1 0

聊聊rest api设计

序本文主要研究下rest api的设计。设计准则 easy to use & hard to misuse 易用不易误用，也就是api设计不要太复杂，要简单易用，而且还不能容易用错。...版本不建议版本化，建议采用新的领域命名才与原有的api区分开来输出规范返回码遵循http的返回码规范，4xx表示客户端错误，5xx表示服务端错误。...防止文件下载目录遍历对于提供文件下载的接口，一定要避免目录遍历问题服务质量保障提供SLA 提供流量管理、熔断、限流提供服务扩容机制提供故障演练提供审计功能监控异常流量提供调用方间的隔离小结 rest...api的设计牵扯的方面比较多，本文暂时只是先列了一些，后续有待补充。...doc API设计要点聊聊jpa的动态查询使用RSQL实现端到端的动态查询

1.6K1 0

点击加载更多

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

一个简约可行的 REST API 规范

用ASP.NET Core 2.1 建立规范的 REST API -- 保护API和其它

用ASP.NET Core 2.1 建立规范的 REST API -- HATEOAS

Rest api简介

Elasticsearch：REST API

用ASP.NET Core 2.0 建立规范的 REST API -- 预备知识

REST API设计指导——译自Microsoft REST API Guidelines（二）

REST API设计指导——译自Microsoft REST API Guidelines（一）

REST API设计指导——译自Microsoft REST API Guidelines（四）

REST API设计指导——译自Microsoft REST API Guidelines（三）

用ASP.NET Core 2.0 建立规范的 REST API -- GET 和 POST

用ASP.NET Core 2.1 建立规范的 REST API -- 缓存和并发

什么是REST API

Yarn Rest Api使用

Microsoft REST API指南

Elasticsearch(二)——Rest API

【Elasticsearch】Rest风格API

Storm UI REST API

聊聊rest api设计

相关资讯

热门标签

活动推荐

运营活动

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐