文档建议反馈控制台
首页
学习
活动
专区
圈层
工具
MCP广场
文章/答案/技术大牛
发布
    • 您找到你想要的搜索结果了吗？
    是的
    没有找到

    Rest api简介

    因此，我们在设计 REST API 的时候，应该提供完备的内容协商能力。 使用 URL 参数进行内容协商 最容易想到的自然是通过 URL 参数进行控制，我们经常看到形如 / 航班号 /entry?...format=JSON 这样的 URL。这种方式的优势就是简单灵活， 你可以通过任何 URL 参数来组合你的输出格式。...并且，过多的参数会导致 URL 的可读性变差，更有甚者，可能会导致 URL 过长，超出规范，API 请求无法执行。 更为标准的内容协商方式是使用 HTTP 头。...使用 HTTP 头进行缓存处理 在 REST 的构架中，我们除了在与后台的数据交换中，需要有一个良好的缓存机制外，针对 REST API 请求都是在远端用 HTTP 发起这一特点，还需要为网络缓存进行更多考虑...REST 安全： 除了使用固有的 HTTP 基本验证，你还可以考虑通过支持表单验证，LTPA 验证，Open ID 验证等方式，来满足更多的企业安全要求。

    3K60

    浅谈 REST API 身份验证的四种方法

    在平时开发中，接口验证是必须的，不然所有人都能请求你的接口，会带来严重的后果，接口验证一般有四种方法：图片让我们直接开始！TOC什么是认证和授权？在开始谈接口验证前，我们有必要先了解一下认证和授权。...3、API密钥认证api密钥认证使用率非常高，而且也非常灵活，我们先来看一下API密钥认证是如何工作的：图片如图：客户端先去向授权服务器请求到API KEY生成后的KEY可以入库记录客户端访问API服务的带上...API KEY此API KEY 由数字和字母组成，一般至少 30 个字符长API KEY 举例Authorization: Apikey fa34sfs32wrwr3432wfa3532tfsaf3fAPI...API KEY缺点API KEY实际意义上并不是授权，有人还是可以获取 API 密钥并获得对他们可用的所有信息的访问权限，就像使用 HTTP 基本身份验证一样，API 密钥只是消除了攻击者猜测进入系统的方式的能力...总结本文介绍了四种rest api身份验证方法：HTTP认证令牌认证OAuth 2.0认证OpenID Connect认证最不安全的就是HTTP认证中的基本认证，常用一般是令牌认证、OAuth 2.0认证

    3.4K31

    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就知道可以拿到什么。

    1.8K30

    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

    1.7K30

    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...用户应该能够轻松读懂和理解URL的结构。 PS：API URL路径结构应该是友好的易于理解的。甚至用户无需通过阅读API文档能够猜出相关结构和路径。...符合 Microsoft REST API 指南的 API 应该支持 PATCH 方法。

    3K50

    Microsoft REST API指南

    Microsoft REST API指南 摘要 Microsoft REST API指南作为一种设计原则，鼓励应用程序开发人员通过RESTful HTTP接口访问资源。...符合Microsoft REST API准则的API应该支持PATCH。 7.4.3....请注意，不建议在URL中传递身份验证令牌，因为它可能导致令牌记录在服务器日志中，并暴露给有权访问这些日志的任何人。...通过URL接受身份验证令牌的服务必须采取措施来降低安全风险，例如使用短期身份验证令牌，禁止记录身份验证令牌以及控制对服务器日志的访问。 避免要求cookie。...需要基于cookie的身份验证的服务必须使用“动态验证码（dynamic canary）” [*]译者注：服务器生成某种验证码，客户端获取后，服务器再进行验证的操作。

    6.2K11

    什么是REST API

    注意，浏览器向REST API发出两个请求： 对同一URL的HTTP OPTIONS请求确定Access-Control-Allow-Origin HTTP响应头是否有效。 实际的REST调用。...REST API版本控制 API的变化是不可避免的，但端点的URL永远不应该失效，否则会破坏使用它们的应用程序。 为了避免兼容性问题，API通常是有版本的。...因此，一个API请求可以被验证，以确保一个用户已经登录并拥有适当的权限。 第三方应用程序必须使用替代的授权方法。常见的认证选项[15]包括： HTTP基本身份验证[16]。...API身份验证将根据使用上下文而有所不同： 在某些情况下，第三方应用程序被视为像任何其他具有特定权利和权限的登录用户。例如，一个地图API可以将两点之间的方向返回给调用的应用程序。...使用健壮的身份验证方法。 使用CORS来限制客户端对特定域的调用。 提供最少的功能，也就是不要创建不需要的DELETE选项。 验证所有端点URL和body对象。

    6K20

    REST API 最佳实践

    在这篇文章中，我将带你了解创建 REST API 时需要遵循的一些最佳实践。这将帮助你创建最好的 API，并使你的 API 用户使用起来更容易。 0.什么是 REST API？...1.REST API 设计建议 1.用名词表示资源 当你设计一个 REST API 时，你不应该在端点路径中使用动词。端点应该使用名词，表示它们各自的作用。...如一个使用连字符的 REST API URL 可能如下所示： https://api.example.com/users/john-doe 而使用下划线的 URL 则可能如下所示： https://api.example.com.../users/john_doe 虽然两者在技术上都是有效的 URL，但前者更符合 REST API 的最佳实践。...运行在 SSL 上的 REST API 的 URL 与不运行在 SSL 上的 URL 的明显区别是 HTTP 中的 “s”：https://mysite.com/posts 运行在 SSL 上，http

    2.8K20

    聊聊rest api设计

    序 本文主要研究下rest api的设计。 设计准则 easy to use & hard to misuse 易用不易误用，也就是api设计不要太复杂，要简单易用，而且还不能容易用错。...输入规范 url中的参数避免驼峰，避免下划线，优先采用横杠 分页比如page及size，或者limit及offset 排序比如sort=+field2,-field2，用逗号分隔多个排序字段，用+表示升序...账号密码需要加密登陆接口必须走https，而且必须要有图形验证码，而且还必须防暴力破解，有错误锁定机制，对于密码的传递，必须加密处理 防止id遍历问题对于url的参数，如果id是递增的，则需要处理遍历问题...服务质量保障 提供SLA 提供流量管理、熔断、限流 提供服务扩容机制 提供故障演练 提供审计功能 监控异常流量 提供调用方间的隔离 小结 rest api的设计牵扯的方面比较多，本文暂时只是先列了一些...doc API设计要点 聊聊jpa的动态查询 使用RSQL实现端到端的动态查询

    1.3K10

    REST API工具推荐

    它可以： 从源代码控制、文件和 URL 导入 API。 与你的 GitHub、GitLab 或 Bitbucket 帐户集成。 预览实时文档。...Insomnia 是一个桌面应用，可以使用 Git sync 选项调试 API 规范。“设计”部分提供带有详细错误消息的样式验证。自动生成的预览与 Swagger Editor 很像。...Talend API Tester 是专用于测试 HTTP 和 REST API 的工具。...它的主要功能有： 发送请求并检查响应 验证 API 行为 导入 Postman、Swagger、OAS、OpenAPI、HAR 测试集合 借助 APITester，你可以创建具有自定义变量、安全保障和身份验证的动态请求...如果你需要在 REST 服务中采用 SOAP 服务，或者你消费 API但想通过中间人公开 API 的后端服务，它会为你提供具有许多策略选项（配额、身份验证、数据中介、缓存）的代理向导。。

    3.2K30

    REST API 还是 GraphQL？

    前言 说到 API 设计，GraphQL 和 RESTful API 是当前最主流的两种选择，各自有其独特优势与挑战。...GraphQL 另外，相比 REST 的多次接口调用，GraphQL 支持聚合请求，有效减少 HTTP 请求次数。...RESTful API 优劣势 RESTful API 是目前最广泛使用的接口规范，基于 HTTP 协议，使用资源路径和请求方法组合完成数据操作。...而且通过 Postman、curl 等工具即可快速测试和验证接口。 但它也存在一些问题： 比如，请求冗余，无法控制字段粒度，常常返回大量用不到的数据！...还有就是扩展性不如 GraphQL，对于需要动态字段、自定义响应结构的场景，REST 显得不够灵活！ 最后 GraphQL 和 REST 各有千秋，关键在于选择适合自己团队和项目的方案。

    43610

    快速模拟 Rest API

    在前后端开发过程中，通常会通过 web api 进行沟通，Rest 风格和 JSON结构是常用的，例如前端要获取文章列表，需要通过 GET /post 来取得数据，返回的数据例如 { "posts"...: [ { "id": 1, "title": "test", "author": "me" }, ...... ] } 后端来定义路由和返回JSON数据 开发中，后端实现API的速度可能不能满足前端开发的速度...，前端为了不必等待后端，可以自己来模拟这个API，按照规定好的数据结构来返回模拟数据 json-server 就是用来实现这个需求的，不用自己写任何代码，把自己需要的模拟数据写入一个JSON文件，json-server...可以加载这个文件，并对外提供REST风格的访问方式，下面通过示例看具体的使用方式 先通过 npm 安装 json-server npm install -g json-server 然后自定义一个JSON

    2.4K40
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

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

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

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

      领券