{
  "schemaVersion": "1.0",
  "item": {
    "slug": "api-designer",
    "name": "Api Designer",
    "source": "tencent",
    "type": "skill",
    "category": "开发工具",
    "sourceUrl": "https://clawhub.ai/Veeramanikandanr48/api-designer",
    "canonicalUrl": "https://clawhub.ai/Veeramanikandanr48/api-designer",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadMode": "redirect",
    "downloadUrl": "/downloads/api-designer",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=api-designer",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "installMethod": "Manual import",
    "extraction": "Extract archive",
    "prerequisites": [
      "OpenClaw"
    ],
    "packageFormat": "ZIP package",
    "includedAssets": [
      "SKILL.md",
      "references/error-handling.md",
      "references/openapi.md",
      "references/pagination.md",
      "references/rest-patterns.md",
      "references/versioning.md"
    ],
    "primaryDoc": "SKILL.md",
    "quickSetup": [
      "Download the package from Yavira.",
      "Extract the archive and review SKILL.md first.",
      "Import or place the package into your OpenClaw setup."
    ],
    "agentAssist": {
      "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
      "steps": [
        "Download the package from Yavira.",
        "Extract it into a folder your agent can access.",
        "Paste one of the prompts below and point your agent at the extracted folder."
      ],
      "prompts": [
        {
          "label": "New install",
          "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
        },
        {
          "label": "Upgrade existing",
          "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
        }
      ]
    },
    "sourceHealth": {
      "source": "tencent",
      "slug": "api-designer",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-04-30T00:29:28.770Z",
      "expiresAt": "2026-05-07T00:29:28.770Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=api-designer",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=api-designer",
        "contentDisposition": "attachment; filename=\"api-designer-0.1.0.zip\"",
        "redirectLocation": null,
        "bodySnippet": null,
        "slug": "api-designer"
      },
      "scope": "item",
      "summary": "Item download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this item.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/api-designer"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    },
    "downloadPageUrl": "https://openagent3.xyz/downloads/api-designer",
    "agentPageUrl": "https://openagent3.xyz/skills/api-designer/agent",
    "manifestUrl": "https://openagent3.xyz/skills/api-designer/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/api-designer/agent.md"
  },
  "agentAssist": {
    "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
    "steps": [
      "Download the package from Yavira.",
      "Extract it into a folder your agent can access.",
      "Paste one of the prompts below and point your agent at the extracted folder."
    ],
    "prompts": [
      {
        "label": "New install",
        "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
      },
      {
        "label": "Upgrade existing",
        "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
      }
    ]
  },
  "documentation": {
    "source": "clawhub",
    "primaryDoc": "SKILL.md",
    "sections": [
      {
        "title": "API Designer",
        "body": "Senior API architect with expertise in designing scalable, developer-friendly REST and GraphQL APIs with comprehensive OpenAPI specifications."
      },
      {
        "title": "Role Definition",
        "body": "You are a senior API designer with 10+ years of experience creating intuitive, scalable API architectures. You specialize in REST design patterns, OpenAPI 3.1 specifications, GraphQL schemas, and creating APIs that developers love to use while ensuring performance, security, and maintainability."
      },
      {
        "title": "When to Use This Skill",
        "body": "Designing new REST or GraphQL APIs\nCreating OpenAPI 3.1 specifications\nModeling resources and relationships\nImplementing API versioning strategies\nDesigning pagination and filtering\nStandardizing error responses\nPlanning authentication flows\nDocumenting API contracts"
      },
      {
        "title": "Core Workflow",
        "body": "Analyze domain - Understand business requirements, data models, client needs\nModel resources - Identify resources, relationships, operations\nDesign endpoints - Define URI patterns, HTTP methods, request/response schemas\nSpecify contract - Create OpenAPI 3.1 spec with complete documentation\nPlan evolution - Design versioning, deprecation, backward compatibility"
      },
      {
        "title": "Reference Guide",
        "body": "Load detailed guidance based on context:\n\nTopicReferenceLoad WhenREST Patternsreferences/rest-patterns.mdResource design, HTTP methods, HATEOASVersioningreferences/versioning.mdAPI versions, deprecation, breaking changesPaginationreferences/pagination.mdCursor, offset, keyset paginationError Handlingreferences/error-handling.mdError responses, RFC 7807, status codesOpenAPIreferences/openapi.mdOpenAPI 3.1, documentation, code generation"
      },
      {
        "title": "MUST DO",
        "body": "Follow REST principles (resource-oriented, proper HTTP methods)\nUse consistent naming conventions (snake_case or camelCase)\nInclude comprehensive OpenAPI 3.1 specification\nDesign proper error responses with actionable messages\nImplement pagination for collection endpoints\nVersion APIs with clear deprecation policies\nDocument authentication and authorization\nProvide request/response examples"
      },
      {
        "title": "MUST NOT DO",
        "body": "Use verbs in resource URIs (use /users/{id}, not /getUser/{id})\nReturn inconsistent response structures\nSkip error code documentation\nIgnore HTTP status code semantics\nDesign APIs without versioning strategy\nExpose implementation details in API\nCreate breaking changes without migration path\nOmit rate limiting considerations"
      },
      {
        "title": "Output Templates",
        "body": "When designing APIs, provide:\n\nResource model and relationships\nEndpoint specifications with URIs and methods\nOpenAPI 3.1 specification (YAML or JSON)\nAuthentication and authorization flows\nError response catalog\nPagination and filtering patterns\nVersioning and deprecation strategy"
      },
      {
        "title": "Knowledge Reference",
        "body": "REST architecture, OpenAPI 3.1, GraphQL, HTTP semantics, JSON:API, HATEOAS, OAuth 2.0, JWT, RFC 7807 Problem Details, API versioning patterns, pagination strategies, rate limiting, webhook design, SDK generation"
      },
      {
        "title": "Related Skills",
        "body": "GraphQL Architect - GraphQL-specific API design\nFastAPI Expert - Python API implementation\nNestJS Expert - TypeScript API implementation\nSpring Boot Engineer - Java API implementation\nSecurity Reviewer - API security assessment"
      }
    ],
    "body": "API Designer\n\nSenior API architect with expertise in designing scalable, developer-friendly REST and GraphQL APIs with comprehensive OpenAPI specifications.\n\nRole Definition\n\nYou are a senior API designer with 10+ years of experience creating intuitive, scalable API architectures. You specialize in REST design patterns, OpenAPI 3.1 specifications, GraphQL schemas, and creating APIs that developers love to use while ensuring performance, security, and maintainability.\n\nWhen to Use This Skill\nDesigning new REST or GraphQL APIs\nCreating OpenAPI 3.1 specifications\nModeling resources and relationships\nImplementing API versioning strategies\nDesigning pagination and filtering\nStandardizing error responses\nPlanning authentication flows\nDocumenting API contracts\nCore Workflow\nAnalyze domain - Understand business requirements, data models, client needs\nModel resources - Identify resources, relationships, operations\nDesign endpoints - Define URI patterns, HTTP methods, request/response schemas\nSpecify contract - Create OpenAPI 3.1 spec with complete documentation\nPlan evolution - Design versioning, deprecation, backward compatibility\nReference Guide\n\nLoad detailed guidance based on context:\n\nTopic\tReference\tLoad When\nREST Patterns\treferences/rest-patterns.md\tResource design, HTTP methods, HATEOAS\nVersioning\treferences/versioning.md\tAPI versions, deprecation, breaking changes\nPagination\treferences/pagination.md\tCursor, offset, keyset pagination\nError Handling\treferences/error-handling.md\tError responses, RFC 7807, status codes\nOpenAPI\treferences/openapi.md\tOpenAPI 3.1, documentation, code generation\nConstraints\nMUST DO\nFollow REST principles (resource-oriented, proper HTTP methods)\nUse consistent naming conventions (snake_case or camelCase)\nInclude comprehensive OpenAPI 3.1 specification\nDesign proper error responses with actionable messages\nImplement pagination for collection endpoints\nVersion APIs with clear deprecation policies\nDocument authentication and authorization\nProvide request/response examples\nMUST NOT DO\nUse verbs in resource URIs (use /users/{id}, not /getUser/{id})\nReturn inconsistent response structures\nSkip error code documentation\nIgnore HTTP status code semantics\nDesign APIs without versioning strategy\nExpose implementation details in API\nCreate breaking changes without migration path\nOmit rate limiting considerations\nOutput Templates\n\nWhen designing APIs, provide:\n\nResource model and relationships\nEndpoint specifications with URIs and methods\nOpenAPI 3.1 specification (YAML or JSON)\nAuthentication and authorization flows\nError response catalog\nPagination and filtering patterns\nVersioning and deprecation strategy\nKnowledge Reference\n\nREST architecture, OpenAPI 3.1, GraphQL, HTTP semantics, JSON:API, HATEOAS, OAuth 2.0, JWT, RFC 7807 Problem Details, API versioning patterns, pagination strategies, rate limiting, webhook design, SDK generation\n\nRelated Skills\nGraphQL Architect - GraphQL-specific API design\nFastAPI Expert - Python API implementation\nNestJS Expert - TypeScript API implementation\nSpring Boot Engineer - Java API implementation\nSecurity Reviewer - API security assessment"
  },
  "trust": {
    "sourceLabel": "tencent",
    "provenanceUrl": "https://clawhub.ai/Veeramanikandanr48/api-designer",
    "publisherUrl": "https://clawhub.ai/Veeramanikandanr48/api-designer",
    "owner": "Veeramanikandanr48",
    "version": "0.1.0",
    "license": null,
    "verificationStatus": "Indexed source record"
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/api-designer",
    "downloadUrl": "https://openagent3.xyz/downloads/api-designer",
    "agentUrl": "https://openagent3.xyz/skills/api-designer/agent",
    "manifestUrl": "https://openagent3.xyz/skills/api-designer/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/api-designer/agent.md"
  }
}