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

template.md

View on GitHub
# API Developer Report Template

## Output Location
Write your report to: `$VNX_DATA_DIR/unified_reports/`

## Filename Format
`{timestamp}-{track}-api-{title}.md`

Example: `20260202-143000-A-api-user-endpoints.md`

## Report Structure

### Summary
Brief overview of API work completed (2-3 sentences)

### Tags (Required)
- [tag1, tag2, tag3]  # Use specific, compound tags (e.g., sse-streaming, browser-pool, kvk-validation). Avoid general-only tags.

### API Implementation
- Endpoints created/modified
- HTTP methods and routes
- Request/response schemas
- Authentication/authorization

### Code Changes
- Controller functions
- Middleware added
- Route configurations
- Schema definitions

### API Documentation
- OpenAPI/Swagger updates
- Endpoint descriptions
- Example requests/responses
- Error codes documented

### Testing
- API tests written
- Postman/Insomnia collections
- Load testing results (if applicable)
- Integration test coverage

### Evidence
- Working API calls with curl examples
- Response examples
- Performance metrics
- Test output

### Recommendations
- Security improvements
- Performance optimizations
- API versioning considerations
- Next endpoints to implement

### Intelligence Feedback
<!-- If your dispatch included [INTELLIGENCE_DATA] with offered_pattern_hashes, report which patterns you actually used: -->
used_pattern_hashes: []

## Quality Standards
- Follow RESTful conventions
- Include complete OpenAPI documentation
- Provide curl examples for all endpoints
- Document all error responses
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