将api设计为ui与rest端点的权衡

在现代应用程序开发中，将API公开为用户界面（UI）或REST端点是一个需要权衡的关键问题。我们需要明确这些权衡的内容，并探索如何在两者之间找到平衡点。

应用程序的本质与API的角色

应用程序的核心功能可以归结为以下几点：它存储数据（可能在本地，也可能在远程服务器上），并通过API提供操作这些数据的能力。这个API可以以UI的形式呈现，也可以是一个REST API。无论形式如何，UI的操作都需要映射到底层API。这种映射关系表明，UI/UX设计实际上是API设计的一种表现形式。

UI与REST API的权衡分析

传统UI交互的优缺点

限制：

操作速度慢：移动光标和点击操作会增加摩擦。
受设计师限制：设计师决定了可用的操作范围，无法完全满足个性化需求。
无法自动化：传统UI难以支持自动化操作。

优点：

快速上手：用户可以在短时间内熟悉并使用界面。
可视化能力强：UI可以通过滑块、图表等二维空间元素直观呈现数据。
丰富的交互：支持文字输入、按钮点击、滑块拖动等多样化操作。

传统REST API交互的优缺点

限制：

需要编写代码：用户必须具备一定的编程能力。
启动复杂：涉及身份验证、API密钥获取等步骤。
仅限文本交互：通常以JSON格式返回数据，缺乏直观性。
交互性差：只能通过序列化数据与端点通信。

优点：

易于自动化：尽管需要编写代码，但自动化能力强。
功能强大：简单的CRUD操作可以组合完成复杂任务。
可与其他服务集成：支持跨服务的交互。

新的交互方式探索

为了弥补传统UI和REST API的不足，开发者尝试了多种新的交互方式：

终端风格的交互

许多现代应用引入了命令行式的交互方式，用户可以通过输入命令直接执行操作。这种方式结合了快速的键盘输入和传统UI的直观性。

示例：

Raycast：通过快速打字替代鼠标点击，提升操作效率。
Figma：支持通过拖动和点击进行复杂的设计操作。

上下文感知的API设计

在现实生活中，我们常通过上下文进行模糊指令，例如“把它搬到楼上”。这种上下文感知的能力可以应用于API设计中，使其更自然。例如：

在REST API中，通过类似api.enterContext("currentUser").enterContext("repositories").createNew().run()的方式，用户可以逐步导航到目标操作。

理想的API交互框架

一个优秀的API交互框架应具备以下特性：

快速上手：像浏览网页一样简单。
丰富的可视化和交互：支持滑块、地图等多样化元素。
键盘优先：通过键盘输入快速完成操作。
上下文感知：利用上下文简化复杂操作。
强大且可组合：支持与底层API的全面交互，并能与其他服务集成。

这些特性结合了传统UI和REST API的优点，同时尽量避免其缺点。

UI设计与REST API设计的统一性

UI设计和REST API设计看似分属不同领域，但实际上它们是同一事物的不同表现形式。两者可以互相借鉴，形成更高效的交互模式。例如：

UI设计可以从REST API中学习如何提供强大的自动化能力。
REST API设计可以从UI中借鉴直观的交互方式和上下文感知能力。

这种统一性表明，设计和编程在本质上是相通的，只是应用场景不同。

总结

在UI和REST API的设计中，我们需要平衡速度、直观性和功能性。通过结合键盘优先、上下文感知和丰富的交互方式，我们可以设计出更自然、更高效的API交互框架。最终，UI和REST API的设计不应被视为孤立的领域，而是可以相互学习、共同进步的整体。

原文链接: https://tanishqkancharla.dev/blog/ui-as-an-api