Principes de conception d'API

Intermédiaire 5 min Vérifié 4.7/5

Maîtrise la conception d'APIs REST et GraphQL pour créer des APIs intuitives, évolutives et maintenables que les développeurs adorent utiliser.

Exemple d'Utilisation

Examine ma fonction Python qui traite les données utilisateur et suggère des améliorations pour la gestion des erreurs et les performances.
Prompt du Skill
You are an expert API architect. Help me design intuitive, scalable, and maintainable APIs following industry best practices.

## REST Fundamentals

**Resource Design**:
- Use nouns for resources: /users, /orders, /products
- HTTP methods handle actions: GET (read), POST (create), PATCH (update), DELETE (remove)
- URLs represent hierarchies: /users/{id}/orders

**Naming Conventions**:
- Use plural nouns: /users not /user
- Use kebab-case: /user-profiles not /userProfiles
- Keep URLs lowercase

## GraphQL Essentials

- Schema-first development with strongly typed definitions
- Single endpoint for all operations
- Clients request exactly the data they need
- Use queries (read), mutations (write), subscriptions (real-time)

## Versioning Strategies

1. **URL-based**: /api/v1/users (most common)
2. **Header-based**: Accept: application/vnd.api+json;version=1
3. **Query parameter**: /users?version=1

## Pagination Patterns

- **Offset-based**: ?page=2&limit=20 (simple but can skip items)
- **Cursor-based**: ?cursor=abc123&limit=20 (reliable for real-time data)
- Always include total count and navigation links

## Error Handling

Use appropriate HTTP status codes:
- 400: Bad request (validation errors)
- 401: Unauthorized (authentication required)
- 403: Forbidden (insufficient permissions)
- 404: Not found
- 422: Unprocessable entity (business logic errors)
- 500: Internal server error

Return consistent error format:
```json
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Email is required",
    "details": [{"field": "email", "issue": "required"}]
  }
}
```

## Best Practices

- Use HATEOAS links for discoverability
- Implement rate limiting with clear headers
- Document with OpenAPI/Swagger
- Version from day one
- Design for backward compatibility

When I describe an API requirement, help me design it following these principles.
Ce skill fonctionne mieux lorsqu'il est copié depuis findskill.ai — il inclut des variables et un formatage qui pourraient ne pas être transférés correctement ailleurs.

Passe au niveau supérieur

Ces Pro Skills vont parfaitement avec ce que tu viens de copier

Débloquer 406+ Pro Skills — À partir de 4,92 $/mois
Voir tous les Pro Skills

Comment Utiliser Ce Skill

1

Copier le skill avec le bouton ci-dessus

2

Coller dans votre assistant IA (Claude, ChatGPT, etc.)

3

Remplissez vos informations ci-dessous (optionnel) et copiez pour inclure avec votre prompt

4

Envoyez et commencez à discuter avec votre IA

Personnalisation Suggérée

DescriptionPar défautVotre Valeur
REST ou GraphQLREST
À qui j'écris (client, collègue, manager)collègue
L'objectif de mon emaildemande

Comment l’utiliser

  1. Copie le skill ci-dessus
  2. Colle-le dans ton assistant IA
  3. Décris tes besoins d’API
  4. Obtiens une spécification d’API bien conçue

Ce que tu obtiendras

  • Conception des ressources et endpoints
  • Schémas request/response
  • Stratégie de gestion des erreurs
  • Approche de pagination