在您需要为用户描述的任何系统或领域生成完整的、可投入生产的 REST API 端点规范时使用此技能。当用户询问有关 API 设计、API 端点、REST API、API URL 的问题，或说诸如“我需要哪些端点...”、“为...设计一个 API”等类似内容时，请使用此技能。

询问用户他们是只想要端点还是完整的详细响应（仅端点/详细设计）。如果用户在输入中已经指定了他们的需求细节，则不要询问这些选项。

首先将所有端点依次列出作为输出，然后按以下确切结构展开每个端点组（资源）：

请求体 (如果是 GET/DELETE 且没有请求体，可省略)

{
  "field": "type — description",
  "field2": "type — description"
}

400 Bad Request — invalid or missing fields

401 Unauthorized — missing or invalid token

403 Forbidden — insufficient permissions

422 Unprocessable Entity — validation failed

{
  "data": [...],
  "pagination": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "totalPages": 5
  }
}

Admin endpoints Bearer token + role check (403 if not admin)

阅读 references/domains.md，了解每个领域（酒店预订、电子商务、社交媒体等）的预制资源列表，以加速端点生成而不会遗漏显而易见的资源。

阅读 references/testmu_example.md 以生成 API 结构并提供示例。

一旦 API 设计输出完成，请询问用户：

您希望我为此设计生成 API 文档吗？（是/否）

你可以安装它并重新运行，或者我可以生成基础文档

涵盖端点、参数和响应的纯文本 API 文档

来源说明：本文内容整理自开源项目 agentic-awesome-skills（中文翻译版），遵循 CC BY 4.0（知识共享署名 4.0 国际）许可协议，此处作为中文资料整理分享，版权归原作者所有。

Api Designer 实用指南

Generates complete, production-ready REST API endpoint specifications for any system or domain the user describes. Use this skill whenever the user asks about API design, API endpoints, REST APIs, API URLs, or says things like "what endpoints do I need for...", "design an API for...",...

开发工具

架构设计

后端

本文提供API设计师实用指南，涵盖REST API端点设计全流程，包括何时使用技能、输出格式、认证模式、错误代码及分页规则。源自开源Agent Skills合集中文版，帮助生成生产级API规范，支持仅端点或详细设计两种模式，并附域参考速查表加速设计。

身份验证

路由

OAuth

Agent

JSON

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

EdgeOne AI 安全实战专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

Api Designer 实用指南

Api Designer 实用指南

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐