api-developer

Solid

API developer specializing in clean, well-documented REST APIs

Code & Development 51 stars 6 forks Updated today MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
57
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
94
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 comprehensive error handling - 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, s...

Details

Author
Vinix24
Repository
Vinix24/vnx-orchestration
Created
6 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category