api-design-fundamentals
在设计API、选择REST/GraphQL/gRPC之间或理解API设计最佳实践时使用。涵盖协议选择、资源建模和API模式。
把 Skill 的源码、资源快照、README、包体和安装信号放进一个可搜索、可筛选的公开目录。
在设计API、选择REST/GraphQL/gRPC之间或理解API设计最佳实践时使用。涵盖协议选择、资源建模和API模式。
根据行业最佳实践设计干净、可扩展和可维护的REST和GraphQL API。在设计公共或内部API、规划端点结构、定义请求/响应契约、建立版本策略、实现身份验证模式、设计数据模型、创建API文档、确保一致的错误处理、优化性能或在微服务之间建立服务契约时使用。
回答API和技术文档相关的问题。当客户询问API使用、代码实现或集成细节时使用。
在设计或实现API路由时,使用安全最佳实践构建REST API端点。不适用于客户端获取或非API逻辑。
指导按照团队规范创建标准化的REST API端点。在创建新的API端点时使用。
定义一致的API错误代码和响应。当中级开发人员需要错误标准化时使用。
从代码分析生成API使用示例和教程
API网关模式用于微服务架构中的路由、认证、限流和服务组合。在实现API网关、构建BFF层或大规模管理服务间通信时使用。
API设计与实现。用于'API'、'endpoint'、'route'请求
从NestJS控制器生成和更新API文档。在修改控制器、添加端点或用户询问API文档时使用。
使用OpenAPI 3.1、AI驱动的工具来掌握API文档
使用Echo框架创建和组织HTTP API端点的标准
指导按照团队规范创建标准化的REST API端点。在创建新的API端点时使用。
车辆保险数据平台的API端点设计与测试。在设计新的API端点、测试现有端点、验证响应格式或调试API问题时使用。涵盖11个核心端点,包括3个新的饼图分布端点、参数验证、错误处理和集成模式。
API扩展工作流(ports → provider → handler → Mock → 测试 → 前端类型 → UI)的自动化
从Swagger/Go注释生成TypeScript API客户端。在更新API端点、添加新路由或后端更改后重新生成前端API客户端时使用。
激活API设计专家模式。精通REST最佳实践、GraphQL和OpenAPI规范。在设计API契约、端点、请求/响应格式或API文档时使用。
当用户请求摘要("дайджест", "саммари", "что нового", "digest", "summary")时使用 - 通过API获取数据并生成详细分析
全面指南,介绍如何使用序列化、身份验证、版本控制、速率限制和测试在Rails中构建生产就绪的REST API。触发关键词:REST API, JSON, 序列化, 版本控制, 身份验证, JWT, 速率限制, API控制器, 请求规格, API测试, 端点, 响应
编写全面的API文档的专业指南,包括OpenAPI规范、端点参考、认证指南和代码示例。在记录API、创建开发者门户或提高API可发现性时使用。
生成带有请求验证、TypeScript类型、一致的响应格式、错误处理和文档的CRUD REST API端点。包括路由处理器、验证模式(Zod/Joi)、类型化的响应和使用示例。在构建“REST API”、“CRUD端点”、“API路由”或“后端端点”时使用。
为新的Next.js API端点搭建脚手架,包括身份验证、速率限制和测试。在创建新的API路由、添加端点或构建API功能时使用。
标准API信封模式用于所有响应(成功/列表/错误)。将数据包装在具有系统元数据的一致结构中,自动压缩有效载荷(减少30-40%),注入时间戳。触发于'formatEntity', 'formatEntityList', 'formatErrorEntity', 'API', 'route handler', 'dal'。
**API FIRST DESIGN**: '创建API', 'API设计', '端点', 'REST', 'Swagger', 'OpenAPI', 'DTO', 'CRUD' 请求时自动触发。在*.controller.ts/*.dto.ts/routes/**文件工作时自动应用。Contract-First, 标准响应格式, 类型自动生成。