api-portal-design
API documentation and developer portal design
npx skills add majiayu000/claude-skill-registry --skill api-portal-design-melodic-software-claude-code-plugins --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
What it does
Describes how to design an API portal and documentation system, detailing a documentation-first workflow, a developer portal architecture, and a portal content structure with essential sections and sample Getting Started, Authentication, and API Reference content.
How it works
- Recommends: invoke a docs-management skill for documenting patterns, verify OpenAPI/AsyncAPI standards via MCP servers, and base guidance on industry best practices.
- Outlines a Developer Portal Architecture with components like Getting Started, API Reference, Code Examples, SDKs, Authentication & API Keys, and Support areas, presented as a labeled diagram and component blocks.
- Defines a Portal Content Structure with essential sections (Getting Started, Authentication, API Reference, Code Examples) and prioritization (P0/P1/P2).
- Provides a Getting Started guide with prerequisites, a quick start including obtaining an API key, making a first request via curl, and exploring references and samples.
- Includes an Authentication Documentation block detailing API Keys, Bearer tokens, OAuth 2.0, and token usage examples, plus security best practices.
- Contains an OpenAPI Specification Template sample describing security, servers, paths, components, and example responses, to guide API surface design.
- Includes an Error Documentation section illustrating error handling, status codes, and a JSON error schema example (truncated in this excerpt).
When to use it
Use this skill for Api Portal Design tasks, planning or design guidance, and to follow best practices for API documentation and developer portal structure.
What it can touch
The skill declares the Claude Code tool for interaction and allows Read, Glob, Grep, Write, Edit actions to read and modify relevant design artifacts and templates as part of a docs-first design workflow.
Caveats
License: MIT. The provided templates include placeholders and sample content; real deployment should tailor content to the product and ensure API keys and endpoints are accurate for the target environment.
# API Portal Design Skill ## When to Use This Skill Use this skill when: - **Api Portal Design tasks** - Working on api documentation and developer portal design - **Planning or design** - Need guidance on Api Portal Design approaches - **Best practices** - Want to follow established patterns and standards ## Overview Design comprehensive API documentation and developer portals for exceptional developer experience. ## MANDATORY: Documentation-First Approach Before designing API portals: 1. **Invoke `docs-management` skill** for API documentation patterns 2. **Verify OpenAPI/AsyncAPI standards** via MCP servers (context7) 3. **Base guidance on industry API documentation best practices** ## Developer Portal Architecture ```text Developer Portal Components: ┌─────────────────────────────────────────────────────────────────────────────┐ │ Developer Portal │ ├─────────────────────────────────────────────────────────────────────────────┤ │ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │ │ │ Getting │ │ API │ │ Code │ │ API │ │ │ │ Started │ │ Reference │ │ Examples │ │ Console │ │ │ └─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘ │ ├─────────────────────
- When to Use This Skill
- Overview
- MANDATORY: Documentation-First Approach
- Developer Portal Architecture
- Portal Content Structure
- Essential Sections
- Getting Started Guide
- API Keys
- Creating API Keys
- Using API Keys
- Key Security Best Practices
- OAuth 2.0
- Authorization Code Flow
- OAuth Endpoints
curl -X GET "https://api.example.com/v1/resource" \ curl -X POST "https://auth.example.com/oauth/token" \ curl -X POST "https://api.example.com/v1/users" \
What does the api-portal-design skill do?
API documentation and developer portal design
How do I install it?
Run `npx skills add majiayu000/claude-skill-registry --skill api-portal-design-melodic-software-claude-code-plugins --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From majiayu000/claude-skill-registry, a repository with 534 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.