构建和运行前端 API 的七个关键注意事项

更新日期: 2022-02-27 阅读: 1.7k 标签: api

以下是你通过作为前端和后端之间的齿轮箱的 api 思考时的一些注意事项。

1. API 的形状很重要

是否有一种 API 语言比 REST API 的“你从 JSON 响应中得到什么”更灵活,并且比“随心所欲”更适合作为 SQL 构造?原来有GraphQL。对于前端开发人员来说,这太棒了。对于构建 API 的人来说,这同样很棒。为什么?因为它允许连接点、自动文档和“需要时抽象;不需要时详细。”我强烈建议将 GraphQL 实现为这些变速箱 API 的形状。

2. 抽象后端很重要

从根本上说,前端应用程序并不关心数据来自哪里,他们只想要数据。这意味着无论数据来自 REST 端点、SQL 数据库、NoSQL 数据库、GraphQL 后端,甚至是 WSDL/XML 后端,前端都不应该关心。如果有两个不同的后端将数据输入一个通用类型,那就这样吧,前端不应该关心。

3. 性能和可靠性问题

有两种方法可以做 API。要么每个 API 都承担着处理性能(“让我引入缓存”)或错误(“这个后端有时会发出错误数据,让我编写逻辑来绕过它”)的负担,或者每个 API 都声明它的内容这样做,系统就会观察并做正确的事情。第二种模式更可取——想想 SQL,你不编码错误条件或性能。相反,数据库试图并且几乎总是做正确的事情。

4. 如何构建 API 很重要

前端团队的需求随着客户和市场的需求而不断发展。并且同时存在多个前端需求。跟上这一切并不容易。当然,你可以启动一个程序,对其进行编码,并随着需求的发展来管理其生命周期。该程序承担了性能、可靠性等方面的负担。或者,你可以使用声明性构造构建 API — 使用来自后端 Y 的调用实现类型 X。类型 Z 使用此字段连接到类型 X。声明式构造允许快速构建 API。声明式结构还有另外两个真正有用的目的:(i)它们使业务逻辑远离前端 API 和(ii)它们导致更好的部署和运行时特性,因为它更容易推理和采取行动,一个使用声明性构造构建的 API。

5. 部署和运行时特性很重要

启动并运行 API 很重要,但是到达那个点的路比前面的路要短得多。后端永远不稳定,密钥被撤销,不良数据被发出,程序需要扩展,需要监控性能,谁在这样做? API 团队越来越多地采用 API 即服务作为这些日常运营问题的解决方案。

6. API 安全问题

API 为前端团队提供了很大的灵活性和对数据的访问,他们允许他们建立很棒的体验,但是现在,需要做些什么来确保不发生坏事呢?你有后端密钥要管理,你可以管理前端访问控制,如果你决定使用 GraphQL,你会更加头疼“我的突变端点不应该可访问”或“浏览器是否更改了查询参数并且现在正在询问不应该访问的数据?” API 管理可以解决一些问题,但一般来说,GraphQL 和后端密钥相关的问题无法通过围绕你的 API 进行分层 API 管理来解决。

7. 这是API管理吗?

API 管理不应与 API 混淆。虽然许多 API 管理产品允许你在其工具中构建 API,但你越来越希望在适合该 API 的工具中构建 API。例如,如果你的 API 是 GraphQL,你需要一个工具来帮助你构建和运行设计良好且性能良好的 GraphQL API。然后,你可能希望在开发门户、分析和一些使用 API 管理的前端密钥管理中分层。

结论

好的 GraphQL 端点必须平衡很多东西。我相信 GraphQL 真的很强大,对于前端和后端开发人员来说都是一个不错的选择,但是 GraphQL 是新的,构建 GraphQL API 的开发人员必须认识到最佳实践和权衡,他们必须做出有意识的决定来做正确的事。最终,推动平衡的系统和工具将成为构建开发人员和使用 GraphQL API 的开发人员的最佳工具。

本文内容仅供个人学习、研究或参考使用,不构成任何形式的决策建议、专业指导或法律依据。未经授权,禁止任何单位或个人以商业售卖、虚假宣传、侵权传播等非学习研究目的使用本文内容。如需分享或转载,请保留原文来源信息,不得篡改、删减内容或侵犯相关权益。感谢您的理解与支持!

链接: https://fly63.com/article/detial/11230

相关推荐

适合写api接口文档的管理工具有哪些?

现在越来越流行前后端分离开发,使用ajax交互。所以api接口文档就变的十分有意义了,目前市场有哪些比较优秀的接口文档管理工具呢?比如:MinDoc,eoLinker,apizza,RAML,Swagger等等

前后端分离,如何防止api接口被恶意调用或攻击

无论网站,还是App目前基本都是基于api接口模式的开发,那么api的安全就尤为重要了。目前攻击最常见的就是“短信轰炸机”,由于短信接口验证是App,网站检验用户手机号最真实的途径,使用短信验证码在提供便利的同时,也成了呗恶意攻击的对象,那么如何才能防止被恶意调用呢?

超赞的腾讯短网址(微信url.cn短链接)生成api接口

腾讯短网址的应用场景很广,譬如短信营销、邮件推广、微信营销、QQ营销、自媒体推广、渠道推广等,都会用到短网址。究其原因是在于短网址可以降低推广成本、用户记忆成本,提高用户点击率;在特定的场景下推广还能规避关键词,防止域名被拦截

JSON API免费接口_ 免费的天气预报、地图、IP、手机信息查询、翻译、新闻等api接口

整理提供最新的各种免费JSON接口,其中有部分需要用JSONP调用。方面前端同学的学习或在网站中的使用,包括:免费的天气预报、地图、IP、手机信息查询、翻译、新闻等api接口

ACE Editor在线代码编辑器的API使用文档

ACE 是一个开源的、独立的、基于浏览器的代码编辑器,可以嵌入到任何web页面或JavaScript应用程序中。ACE支持超过60种语言语法高亮,并能够处理代码多达400万行的大型文档

浏览器中的图像识别 API

在 Native 开发中,Android 和 IOS 平台都在系统层面直接提供给了应用开发识别图像的一些能力,比如对于二维码/条形码的识别,Android 可以使用 barcode API 、 iOS 可以使用 CIQRCodeFeature API 。

Vue 3.0 体验 Vue Function API

近 Vue 官方公布了 Vue 3.0 最重要的RFC:Function-based component API,并发布了兼容 Vue 2.0 版本的 plugin:vue-function-api,可用于提前体验 Vue 3.0 版本的 Function-based component API

vue-next 函数式 api

在分享 vue-next 各个子模块的实现之前,我觉的有必要比较全面的整理下 vue-next 中提出的函数式 api,了解这些的话,无论是对于源码的阅读,还是当正式版发布时开始学习,应该都会有起到一定的辅助作用

在原生 React Native 应用中使用 Expo API

你可以在任何 React Native 应用程序中使用尽可能少或尽可能多的 Expo SDK。 我们已经花了很多时间构建和维护这些包含原生应用特性的跨平台 API,我们很高兴最终实现了向整个 React Native 生态共享这些 API

构建API的最佳编程语言是什么?

你是否正在设计第一个Web应用程序?也许你过去已经建立了一些,但是目前也正在寻找语言的变化以提高你的技能,或尝试新的东西。有了所有信息,就很难决定为下一个产品或项目选择哪种编程语言。

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!