【API设计】 OpenAPI 规范是设计 API 的最著名方法之一。OAS 指定了描述 API 接口所需的规则和语法。在撰写本文时，我们使用的是 OAS 的第三个版本。

【API设计】 Bump.sh新增了图像尺寸调整功能，允许在API文档中通过Markdown扩展语法自定义图像的宽度和高度，提升文档的视觉吸引力和用户体验。这一功能支持精确控制图像显示效果，包括动态GIF和复杂API图表的展示。

【API设计】 在本文中，我们将探讨 API 网关身份验证的基本知识，讨论主要的身份验证方法，并提供实施和克服 API 网关身份验证挑战的指导 - 为您提供保护数字资产安全的知识。

【API设计】 在当下云原生越发成熟的环境下，API 网关最核心的功能可以概括为：连接 API 消费者和 API 提供者。 实际场景中，除去少部分允许匿名访问的 API 外，提供者往往都会对消费者有所限制，比如只有符合条件的消费者才可以对 API 进...

【API设计】 本文探讨了技术文档作者在API文档中的新角色、必备技能及面临的挑战。技术文档作者通过将复杂技术细节转化为清晰文档，提升开发者体验和API可用性。早期参与API设计能优化API质量，但快速交付和复杂API管理带来挑战。

【API设计】 背景信息 Apache APISIX 是一个动态、实时、高性能的 API 网关，提供负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。它不仅拥有众多实用的插件，而且支持插件动态变更和热插拔。同时在使用服务...

【API设计】 在这篇文章中，我们将通过一个用例示例讨论 AsyncAPI v3.0 提供的主要更改，并描述这如何改进您现有的 API 设计方法。我们将使用此用例创建示例 AsyncAPI 描述，以帮助阐明该方法的优点。

【API设计】 Django 是 Python 语言中最受欢迎的 Web 框架之一。其开箱即用的特性，使得我们可以利用它快速搭建一个传统的 Web 应用。在如今多端横行的互联网，单纯的传统 Web 应用开发已经越来越式微，更多的应用采用了前后端分离的 We...

【API设计】 gin 是golang 中比较流行的框架，很多系统都是在该框架下开发的，这个框架给我的感觉像是Flask在python中的位置，基础的功能都有，但是如果想要很好的使用，还需要开发很多自己的功能与中间件，在看过不少的教程以后，想要记录一下学习...

【API设计】 这篇文章将回顾 JSON Schema 的一些不太为人所知的功能，揭示如何利用这些功能让客户端能够自由请求特定字段，并在 API 响应中塑造数据的结构。

【API设计】 API优先设计是一种在编码前先定义API接口的开发方法，旨在通过先规划API合同来确保团队成员对API的理解一致。随着技术的发展，OpenAPI和AsyncAPI分别成为REST API和事件驱动API的描述标准，显著简化了API生命周期。文章回顾了API设计优先的发展历程，从早期的WSDL和SOAP到现代的OpenAPI和AsyncAPI，并探讨了其优势、工具以及设计优先与代码优先的对比。

【API设计】 本文详细介绍了OpenAPI规范的基本概念及其在API设计中的重要性，包括如何通过10个关键要点来优化API设计。这些要点涵盖了从编写清晰的API标题到定义错误响应模式的各个方面，旨在帮助开发者创建更易于理解和使用的OpenAPI规范。

【API设计】 本文详细介绍了如何利用OpenAPI和AsyncAPI标签功能高效组织和分类API端点，提升API文档的结构和可读性。通过示例展示了标签的定义和应用，以及标签排序、使用外部文档链接等技巧，强调了标记所有端点、避免重复标签等最佳实践。

【API设计】 本文详细介绍了设计多层次API架构的关键步骤和层次划分，包括控制器层、服务层、数据层、模型层和Utils工具包的设计原则和职责。通过明确每一层的功能和包结构，开发者可以提升项目的可维护性和可扩展性，实现优雅编码。

【API设计】 本文探讨了使用README风格的API文档如何提升API设计，通过关注用户实际工作流而非单个操作，显著提升API的可用性和用户体验。文章介绍了OpenAPI规范的基础，传统API文档的局限性，以及如何实施README风格的文档，包括确定用户工作流、提供代码示例和与现有工具集成。