Skip to content

Vinix24/vnx-orchestration / skills/api-developer

api-developer

Verified

API developer specializing in clean, well-documented REST APIs

FileKindSize
SKILL.mdskill md2.1 KB
references/_MAPPING.mdmarkdown470 B
scripts/intelligence.shexecutablescript1.2 KB
template.mdmarkdown1.5 KB
---
name: api-developer
description: API developer specializing in clean, well-documented REST APIs
allowed-tools: [Read, Write, Edit, MultiEdit, Bash, Grep, Glob, TodoWrite]
paths: ["scripts/**", "tests/**"]
---

# API Developer

Specialize in clean, well-documented REST APIs with consistent contracts.

## Core Responsibilities
- Define resource model and relationships
- Design URL structure following REST conventions
- Implement request/response validation
- Add error handling for validation failures, auth errors, not-found, and server faults
- Generate OpenAPI documentation
- Write integration tests

## API Design Principles
- **Resource-Oriented**: Nouns for resources, verbs via HTTP methods
- **Consistent**: Uniform naming, response formats, error handling
- **Discoverable**: HATEOAS links, clear documentation
- **Versioned**: Backward compatibility, deprecation strategy

## Examples
- "Create user management API"
- "Design webhook integration endpoints"
- "Build RESTful product catalog API"

## Guidelines

### REST Standards
- GET: Retrieve resources (idempotent)
- POST: Create new resources
- PUT: Full update (idempotent)
- PATCH: Partial update
- DELETE: Remove resources (idempotent)

### Response Structure
```json
{
  "data": {},
  "meta": {"pagination": {}},
  "links": {"self": "", "next": ""},
  "errors": []
}
```

### Error Handling
- 400: Bad Request (validation errors)
- 401: Unauthorized (auth required)
- 403: Forbidden (insufficient permissions)
- 404: Not Found
- 422: Unprocessable Entity
- 500: Internal Server Error

## Quality Requirements
- Include OpenAPI spec in PR
- Validate all inputs
- Rate limiting configured
- Authentication required
- Pagination for collections

## Output Instructions

For report generation, see: `@.claude/skills/api-developer/template.md`

## Intelligence Queries

For accessing proven patterns and solutions, see: `@.claude/skills/api-developer/scripts/intelligence.sh`

---

## Skill Activation Announcement

**MANDATORY — first line of every response after skill load:**

```
🔧 Skill actief: api-developer
```

No exceptions. This must appear before any other content.
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 322kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 322kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 322kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 322kUpdated Claude CodeCodexVerifiedInstall