api-design

Files (1)

• SKILL.md

SKILL.md (first lines)

# API Design Skill

## Overview
Comprehensive API design skill for REST best practices, GraphQL patterns, OpenAPI spec generation, and versioning strategies with modern API development patterns.

## Features
- REST API design and best practices
- GraphQL schema design and optimization
- OpenAPI specification generation
- API versioning strategies
- API documentation automation
- API testing strategies

## Usage Examples

### Design REST API
```bash
/api-design create --type rest --name user-service --output api.yaml
```

### Generate GraphQL Schema
```bash
/api-design graphql --schema user.graphql --mutations mutations.json
```

### Create OpenAPI Spec
```bash
/api-design openapi --version 3.0 --format json --spec spec.json
```

## Implementation

### REST API Designer
```python
class RESTAPIDesigner:
    """Designs RESTful APIs following best practices"""

    def create_resource(self, name, endpoints, methods=['GET', 'POST', 'PUT', 'DELETE']):
        """Create API resource with endpoints"""
        resource = {
            'name': name,
            'endpoints': [],
            'methods': methods,
            'description': self._generate_description(name)
        }

        for endpoint in endpoints:
            resource['endpoints'].append({
                'path': f"/{name}/{endpoint}",
                'method': methods,
                'parameters': self._generate_parameters(endpoint),
                'responses': self._generate_responses(endpoint)
            })

        return resource

    def validate_rest_compliance(self, api_spec):
        """Validate REST API compliance"""
        checks = {
            'nouns_not_verbs': self._check_nouns_not_verbs(api_spec),
            'http_methods': self._check_http_methods(api_spec),
            'status_codes': self._check_status_codes(api_spec),
            'versioning': self._check_versioning(api_spec)
        }
        return checks

    def generate_hateoas_links(self, resource):
        """Generate HATEOAS links for REST API"""
        return {
            'self': f"/{resource['name']}",
            'collection': f"/{resource['name']}s",
            'related': self._find_related_resources(resource)
        }
```

### GraphQL Designer
```python
class GraphQLDesigner:
    """Designs GraphQL schemas and resolvers"""

    def create_schema(self, types, queries, mutations):
        """Create GraphQL schema"""
        schema = {
            'types': {},
            'queries': {},
            'mutations': {},
            'subscriptions': {}
        }

        # Add types
        for type_name, type_def in types.items():
            schema['types'][type_name] = type_def

        # Add queries
        for query_name, query_def in queries.items():
            schema['queries'][query_name] = {
                'type': query_def['type'],
                'args': query_def.get('args', {}),
                'resolve': query_def.get('resolve')
            }

        # Add mutations
        for mutation_name, mutation_def in mutations.items():
            schema['mutations'][mutation_name] = {
                'type': mutation_def['type'],
                'args': mutation_def.get('args', {}),
                'resolve': mutation_def.get('resolve')
            }

        return schema

    def optimize_schema(self, schema):
        """Optimize GraphQL schema for performance"""
        # Query complexity analysis
        # Schema size optimization
        # Field suggestion optimization
        return schema

    def generate_resolvers(self, schema):

From eroslifestyle/Claude-Orchestrator-AI-Evolution, MIT.

More from eroslifestyle/Claude-Orchestrator-AI-Evolution