EP161：REST API 设计最佳实践备忘单

Posted on 2025-05-04

WorkOS + MCP：AI 代理授权（赞助）

对 MCP 服务器上的每个工具的广泛访问是一个主要的安全风险。未经检查的访问可能很快导致严重事件。

团队需要一种快速、简单的方法来锁定角色和权限的访问。

WorkOS AuthKit 通过 RBAC 使一切变得简单 — 分配角色、强制执行权限并准确控制谁可以访问关键工具。

不要等到违规发生才采取行动。立即保护您的服务器。

观看演示以了解更多信息

本周的系统设计复习：

  • 系统设计很困难 – 直到您知道权衡，第 2 部分（Youtube 视频）

  • REST API 设计最佳实践备忘单

  • 最常用的 30 项 AWS 服务

  • 大语言模型术语表

  • 我们正在 ByteByeGo 招聘

  • 赞助我们

系统设计很困难 – 直到您知道权衡，第 2 部分

REST API 设计最佳实践备忘单

graphical user interface

设计良好的 API 表现一致、公平可预测，并且可以无摩擦地成长。需要记住的一些最佳实践如下：

  1. 面向资源的路径和 HTTP 动词的正确使用有助于 API 与标准工具保持一致。

  2. 使用正确的 API 版本控制方法。

  3. 生成 API 响应时使用标准错误代码。

  4. API 应该是幂等的。它们通过重复请求产生相同的结果来确保安全重试，尤其是对于 POST 操作。

  5. 幂等性密钥允许客户端安全地删除重复操作，但有副作用。

  6. API 应支持分页，以防止性能瓶颈和有效负载膨胀。一些常见的分页策略是基于偏移量、基于光标和基于键集。

  7. 对于设计良好的 API，API 安全性是强制性的。使用 API 密钥、JWT、OAuth2 和其他机制对 API 进行正确的身份验证和授权。 HTTPS 也是生产环境中运行的 API 的必备条件。

轮到您了：您在设计 API 时还遵循哪些其他最佳实践？

Pgvector 与 Qdrant：开源矢量数据库比较（赞助）

正在寻找适合大规模工作负载的开源高性能矢量数据库？我们比较 Qdrant 与 Postgres + pgvector + pgvectorscale。

阅读基准

最常用的 30 项 AWS 服务

No alternative text description for this image

我们按类别对它们进行分组并了解它们的作用。

计算服务
1 – Amazon EC2：云中的虚拟服务器
2 – AWS Lambda：用于事件驱动工作负载的无服务器函数
3 – Amazon ECS：托管容器编排
4 – Amazon EKS：Kubernetes 集群管理服务
5 – AWS Fargate：容器的无服务器计算

存储服务
6 – Amazon S3：可扩展的安全对象存储
7 – Amazon EBS：EC2 实例的块存储
8 – Amazon FSx：完全托管的文件存储
9 – AWS Backup：集中式备份自动化
10 – Amazon Glacier：用于备份的归档冷存储

数据库服务
11 – Amazon RDS：托管关系数据库服务
12 – Amazon DynamoDB：低延迟的 NoSQL 数据库
13 – Amazon Aurora：高性能云原生数据库
14 – Amazon Redshift：可扩展的数据仓库解决方案
15 – Amazon Elasticache：使用 Redis/Memcached 进行内存缓存
16 – Amazon DocumentDB：NoSQL 文档数据库（与 MongoDB 兼容）
17 – Amazon Keyspaces：托管 Cassandra 数据库服务

网络与安全
18 – Amazon VPC：安全云网络
19 – AWS CloudFront：内容交付网络
20 – AWS Route53：可扩展域名系统 (DNS)
21 – AWS WAF：保护 Web 应用程序免受攻击
22 – AWS Shield：针对 AWS 工作负载的 DDoS 保护

人工智能与机器学习
23 – Amazon SageMaker：构建、训练和部署 ML 模型
24 – AWS Rekognition：利用 AI 进行图像和视频分析
25 – AWS Textract：从扫描文档中提取文本
26 – Amazon Comprehend：人工智能驱动的自然语言处理

监控和开发运营
27 – Amazon CloudWatch：AWS 性能监控和警报
28 – AWS X-Ray：应用程序的分布式跟踪
29 – AWS CodePipeline：部署的 CI/CD 自动化
30 – AWS CloudFormation – 基础设施即代码 (IaC)

现在轮到您了：您还会将哪些其他 AWS 服务添加到列表中？

大语言模型术语表

graphical user interface

该术语表可分为高级类别：

  1. 模型：包括基础模型、指令调整模型、多模态模型、推理模型和小语言模型等模型类型。

  2. 培训法学硕士：培训从预训练 RLHF、DPO 和合成数据开始。微调添加了对数据集、检查点、LoRA/QLoRA、护栏和参数调整的控制。

  3. 提示：提示通过用户/系统提示、思想链、少样本/零样本学习来驱动模型如何响应。提示调整和大型上下文窗口有助于形成更精确的多轮对话。

  4. 推理：这就是模型生成响应的方式。关键因素包括温度、最大令牌、种子和延迟。幻觉是这里的一个常见问题，模型使事情听起来很真实。

  5. 检索增强生成：RAG 通过获取真实世界的数据来提高准确性。它使用检索、语义搜索、块、嵌入和 VectorDB。重新排名和索引可确保呈现最佳答案，而不仅仅是最有可能的答案。

轮到你了：你还会在 LLM 术语表中添加什么内容？

我们正在 ByteByeGo 招聘两个新职位：全栈工程师和销售/合作伙伴

角色类型：兼职（每周 20 次以上）或全职
薪酬：有竞争力

全栈工程师（远程）
我们正在招聘一名全栈工程师来构建一个易于使用的教​​育平台并推动以产品为主导的增长。您将与创始人密切合作，在需要时扮演产品经理的角色，优先考虑用户体验和功能影响。您将在快节奏的创业环境中工作，鼓励实验、创造力和使用人工智能工具进行快速原型设计。

我们不太关心多年的经验。我们更关心您所取得的成就，而不是您的简历。分享您的项目、GitHub、作品集或任何能够展示您解决有趣问题和创建有影响力的解决方案的能力的工件。准备好后，请将您的简历和简短说明说明为何您很高兴加入 ByteByteGo，并将其发送至[email protected]

销售/合作伙伴（美国远程角色）
我们正在寻找一位销售和合作伙伴专家来帮助发展我们的时事通讯赞助业务。该职位将重点关注吸引新广告商、培育现有关系以及优化我们的时事通讯和其他媒体格式的收入机会。

我们不太关心多年的经验。最重要的是你有上进心、有组织性并且乐于学习和接受新的挑战。

如何申请：将您的简历以及您为何对这个职位感到兴奋的简短说明发送至[email protected]

赞助我们

让您的产品展示在超过 1,000,000 名技术专业人士面前。

我们的时事通讯将您的产品和服务直接呈现在重要受众面前 – 数十万工程领导者和高级工程师 – 他们对重大技术决策和大宗采购具有影响力。

空间很快就满了 – 立即预订

广告位通常会提前约 4 周售完。为了确保您的广告能够覆盖到这些有影响力的受众，请立即发送电子邮件至[email protected]来预订您的空间。

原文： https://blog.bytebytego.com/p/ep161-a-cheatsheet-on-rest-api-design