II.
SkillArea overview
Reference · liveskill-area:api-design
API Design overview
Designing public APIs — naming, resource modeling, idempotency, pagination, error envelopes, and consistency.
Attributes
displayName
API Design
description
Designing public APIs — naming, resource modeling, idempotency,
pagination, error envelopes, and consistency.
domains
expertiseLevels
- intermediate
- expert
Outgoing edges
applies_to1
- specialization:sdk-platform-development·Specialization
prerequisite_for_learning6
- skill-area:semver-discipline·SkillAreaSemantic Versioning Discipline
- skill-area:breaking-change-management·SkillAreaBreaking Change Management
- skill-area:deprecation-policy·SkillAreaDeprecation Policy
- skill-area:sdk-codegen·SkillAreaSDK Code Generation
- skill-area:plugin-systems·SkillAreaPlugin System Design
- skill-area:api-contract-testing·SkillAreaAPI Contract Testing
uses_tool2
- tool:postman·ToolPostman
- tool:insomnia·ToolInsomnia
Incoming edges
addresses2
- skill:graphql-query·SkillGraphQL Query
- skill:system-design·SkillSystem Design
lib_requires_skill_area39
- lib-agent:code-migration-modernization--api-gateway-configurator·LibraryAgentapi-gateway-configurator
- lib-agent:code-migration-modernization--api-modernization-architect·LibraryAgentapi-modernization-architect
- lib-agent:code-migration-modernization--integration-migration-specialist·LibraryAgentintegration-migration-specialist
- lib-agent:code-migration-modernization--strangler-implementation-agent·LibraryAgentstrangler-implementation-agent
- lib-agent:sdk-platform-development--api-design-reviewer·LibraryAgentapi-design-reviewer
- lib-agent:sdk-platform-development--cli-ux-reviewer·LibraryAgentcli-ux-reviewer
- lib-agent:sdk-platform-development--error-message-reviewer·LibraryAgenterror-message-reviewer
- lib-agent:sdk-platform-development--extensibility-architect·LibraryAgentextensibility-architect
- lib-agent:sdk-platform-development--platform-architect·LibraryAgentplatform-architect
- lib-agent:sdk-platform-development--security-review-agent·LibraryAgentsecurity-review-agent
- lib-agent:software-architecture--api-design-architect·LibraryAgentapi-design-architect
- lib-agent:web-development--api-documentation·LibraryAgentapi-documentation
- lib-process:software-architecture--api-design-specification·LibraryProcessspecializations/software-architecture/api-design-specification
- lib-skill:code-migration-modernization--api-compatibility-analyzer·LibrarySkillapi-compatibility-analyzer
- lib-skill:code-migration-modernization--api-inventory-scanner·LibrarySkillapi-inventory-scanner
- lib-skill:code-migration-modernization--openapi-generator·LibrarySkillopenapi-generator
- lib-skill:code-migration-modernization--soap-to-rest-converter·LibrarySkillsoap-to-rest-converter
- lib-skill:healthcare--health-data-integration·LibrarySkillhealth-data-integration
- lib-skill:sdk-platform-development--actionable-error-formatter·LibrarySkillactionable-error-formatter
- lib-skill:sdk-platform-development--api-gateway-configurator·LibrarySkillapi-gateway-configurator
- lib-skill:sdk-platform-development--error-code-catalog·LibrarySkillerror-code-catalog
- lib-skill:sdk-platform-development--graphql-schema-designer·LibrarySkillgraphql-schema-designer
- lib-skill:sdk-platform-development--health-check-endpoint·LibrarySkillhealth-check-endpoint
- lib-skill:sdk-platform-development--interactive-api-console·LibrarySkillinteractive-api-console
- lib-skill:sdk-platform-development--middleware-chain-designer·LibrarySkillmiddleware-chain-designer
- lib-skill:sdk-platform-development--openapi-spec-generator·LibrarySkillopenapi-spec-generator
- lib-skill:sdk-platform-development--protobuf-grpc-designer·LibrarySkillprotobuf-grpc-designer
- lib-skill:sdk-platform-development--rate-limiter-designer·LibrarySkillrate-limiter-designer
- lib-skill:sdk-platform-development--scope-permission-designer·LibrarySkillscope-permission-designer
- lib-skill:sdk-platform-development--smithy-sdk-generator·LibrarySkillsmithy-sdk-generator
- lib-skill:sdk-platform-development--typespec-sdk-generator·LibrarySkilltypespec-sdk-generator
- lib-skill:software-architecture--api-mock-server·LibrarySkillapi-mock-server
- lib-skill:software-architecture--openapi-generator·LibrarySkillopenapi-generator
- lib-skill:software-architecture--openapi-validator·LibrarySkillopenapi-validator
- lib-skill:software-architecture--swagger-ui-deployer·LibrarySkillswagger-ui-deployer
- lib-skill:web-development--graphql·LibrarySkillgraphql
- lib-skill:web-development--json-schema·LibrarySkilljson-schema
- lib-skill:web-development--openapi·LibrarySkillopenapi
- lib-skill:web-development--rest-api-design·LibrarySkillrest-api-design
prerequisite_for_learning6
- skill-area:aggregated-api-server-development·SkillAreaAggregated API Server Development
- skill-area:gRPC-service-design·SkillAreagRPC Service Design
- skill-area:REST-maturity-levels·SkillAreaREST API Maturity
- skill-area:SDK-design·SkillAreaSDK Design
- skill-area:API-ergonomics·SkillAreaAPI Ergonomics
- skill-area:backend-api-design·SkillAreaBackend API Design
requires_expertise9
- responsibility:api-design-governance·ResponsibilityAPI design governance
- role:code-reviewer·RoleCode Reviewer
- role:fullstack-engineer·RoleFullstack Engineer
- role:backend-engineer·RoleBackend Engineer
- role:staff-engineer-convergent·RoleStaff Engineer
- role:integration-engineer·RoleIntegration Engineer
- role:api-engineer·RoleAPI Engineer
- role:sdk-engineer·RoleSDK Engineer
- role:tech-lead·RoleTech Lead
requires_skill_area31
- stack-profile:grpc-microservice-mesh·StackProfilegRPC Microservice Mesh Stack (Go, gRPC, Kubernetes, PostgreSQL, Prometheus)
- stack-profile:sdk-developer-kit·StackProfileSDK / Developer Kit Stack (TypeScript, tsup, Vitest, Typedoc, npm, GitHub Actions)
- stack-profile:plugin-extension-system·StackProfilePlugin / Extension System Stack (TypeScript, JSON Schema, Vitest, npm, esbuild)
- stack-profile:contract-testing·StackProfileContract Testing (Pact, Docker, GitHub Actions, TypeScript, Node.js)
- stack-profile:enterprise-search-platform·StackProfileEnterprise Search (Elasticsearch, Python, React, Redis, Kubernetes, FastAPI)
- stack-profile:master-data-management·StackProfileMaster Data Management (Python, PostgreSQL, RabbitMQ, Airflow, FastAPI)
- stack-profile:photo-gallery-dam·StackProfilePhoto Gallery / DAM (React, Sharp, Boto3, PostgreSQL, Redis, FastAPI)
- stack-profile:research-data-platform·StackProfileResearch Data Platform (Python, Jupyter, PostgreSQL, Boto3, FastAPI, React)
- stack-profile:lab-information-system·StackProfileLab Information System (Python, FastAPI, PostgreSQL, Boto3, React, Docker)
- stack-profile:runbook-automation·StackProfileRunbook Automation (Python, Ansible, PostgreSQL, Redis, FastAPI, Docker)
- stack-profile:rate-limiting-api-throttle·StackProfileRate Limiting / API Throttle (Go, Redis, Prometheus, Docker)
- stack-profile:feature-flag-service·StackProfileFeature Flag Service (TypeScript, Redis, PostgreSQL, React, Docker, Prometheus)
- stack-profile:ab-testing-platform·StackProfileA/B Testing Platform (Python, PostgreSQL, Redis, React, FastAPI, Prometheus)
- stack-profile:url-shortener-link-analytics·StackProfileURL Shortener / Link Analytics (Go, Redis, PostgreSQL, React, Docker)
- stack-profile:file-storage-object-gateway·StackProfileFile Storage / Object Gateway (Go, Boto3, PostgreSQL, Redis, Docker)
- stack-profile:pdf-generation-service·StackProfilePDF Generation Service (Node.js, Puppeteer, Boto3, Redis, Docker, TypeScript)
- workflow:requirements-elicitation-workshop·WorkflowRequirements Elicitation Workshop
- workflow:community-platform-setup·WorkflowCommunity Platform Setup
- workflow:customer-lifecycle-automation-setup·WorkflowCustomer Lifecycle Automation Setup
- workflow:startup-mvp-validation·WorkflowStartup MVP Validation
- workflow:api-versioning-workflow·WorkflowAPI Versioning Workflow
- workflow:api-deprecation·WorkflowAPI Deprecation
- workflow:partner-integration-review·WorkflowPartner Integration Review
- workflow:golden-path-governance·WorkflowGolden Path Governance
- workflow:internal-developer-platform-catalog-review·WorkflowInternal Developer Platform Catalog Review
- workflow:developer-portal-analytics-review·WorkflowDeveloper Portal Analytics Review
- workflow:contract-renewal-negotiation·WorkflowContract Renewal Negotiation
- workflow:e-procurement-platform-setup·WorkflowE-Procurement Platform Setup
- workflow:helpdesk-platform-migration·WorkflowHelpdesk Platform Migration
- workflow:support-automation-setup·WorkflowSupport Automation Setup
- workflow:medical-data-interoperability-review·WorkflowMedical Data Interoperability Review
stack_part_used_by1
- stack-part:api-gateway·StackPartAPI Gateway
supports1
- definition:kradle-aggregated-kinds·DefinitionKradle Aggregated API Kinds (Postgres-backed)
tool_used_by7
- tool:insomnia·ToolInsomnia
- tool:postman·ToolPostman
- tool:hoppscotch·ToolHoppscotch
- tool:httpie·ToolHTTPie
- tool:bruno·ToolBruno
- tool:rapidapi·ToolRapidAPI
- tool:swagger-editor·ToolSwagger Editor