# Conception de solution & d'interface

Canonical page: https://apiopscycles.com/fr/stations/api-design

Language: fr

Entity ID: api-design

## Description

Concevez le mode de mise en œuvre choisi, le contrat d'interface, les modèles d'interaction, les structures de données et les détails d'utilisation avant l'implémentation.

## Why it matters

Une bonne conception va au-delà du nommage des endpoints. Elle garantit que l'interface est utilisable, cohérente, vérifiable et traçable aux besoins métier et utilisateurs.

## Apply in work

Utilisez les ressources de conception adaptées au mode de mise en œuvre choisi, par exemple REST, GraphQL, événements, fichiers, produits de données ou intégration directe.

## Outcomes

- Un contrat d'interface validé pour le mode de mise en œuvre choisi
- Contrats d'interface réutilisables et validés
- Conceptions alignées sur les modèles de domaine et les modèles d'interaction
- Traçabilité de la conception à la valeur métier

## Steps

1. Clarifiez les objets métier, les termes, les règles et les responsabilités avant de concevoir le contrat d'interface.
2. Utilisez le canevas d'interaction pour définir la manière dont les utilisateurs interagiront avec l'API, en veillant à ce qu'elle réponde à leurs besoins et à leurs attentes.
3. Appliquer les modèles de conception REST pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes.
4. Appliquer des modèles de conception orientés événements pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes.
5. Appliquer les modèles de conception GraphQL pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes.
6. Utiliser les principes de conception et le guide de style des API pour aligner vos décisions de conception sur des règles communes et permettre une validation d'audit cohérente.
7. Appliquez des approches « contract-first » ou « design-first » pour définir et valider le contrat de l'API avant sa mise en œuvre.
8. Utilisez la liste de contrôle d'audit des API pour vous assurer que la conception de l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.

## Questions

- Clarifiez les objets métier, les termes, les règles et les responsabilités avant de concevoir le contrat d'interface.
- Utilisez le canevas d'interaction pour définir la manière dont les utilisateurs interagiront avec l'API, en veillant à ce qu'elle réponde à leurs besoins et à leurs attentes.
- Appliquer les modèles de conception REST pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes.
- Appliquer des modèles de conception orientés événements pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes.
- Appliquer les modèles de conception GraphQL pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes.
- Utiliser les principes de conception et le guide de style des API pour aligner vos décisions de conception sur des règles communes et permettre une validation d'audit cohérente.
- Appliquez des approches « contract-first » ou « design-first » pour définir et valider le contrat de l'API avant sa mise en œuvre.
- Utilisez la liste de contrôle d'audit des API pour vous assurer que la conception de l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.
- Utilisez les ressources de conception adaptées au mode de mise en œuvre choisi, par exemple REST, GraphQL, événements, fichiers, produits de données ou intégration directe.
- Une bonne conception va au-delà du nommage des endpoints. Elle garantit que l'interface est utilisable, cohérente, vérifiable et traçable aux besoins métier et utilisateurs.

## Evidence

- spec
- contract
- design-artifact
- documentation

## Completion criteria

- L'architecture, la plateforme et le mode de mise en œuvre choisis ont été validés avec les parties prenantes concernées en architecture, sécurité et plateforme. — The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders. (ID: architecture-patterns-validated)
- L’interface choisie fournit une abstraction appropriée aux utilisateurs. — The API is intended to shield consumers from backend complexity and inconsistencies. (ID: hide-backend-discrepancies)
- La conception de l'interface et les capacités exposées sont clairement reliées à la valeur métier et aux besoins des utilisateurs. — The API design and exposed capabilities clearly trace back to business value and user needs. (ID: design-reflects-business-value)
- La conception de l'interface respecte les standards partagés de produit, de conception et de qualité. — The API design follows our shared API product and design conventions. (ID: api-consistency)

## Role participation and responsibilities

- [Architecte d'intégration](https://apiopscycles.com/fr/roles/integration-architect.md) (lead): Conçoit les approches d’intégration et les modes de mise en œuvre qui relient la capacité ou l’API aux autres systèmes.; suggested-answer-owner: [Canevas de conception de solution d’intégration](https://apiopscycles.com/fr/resources/integration-solution-design-canvas.md)
- [Designer API](https://apiopscycles.com/fr/roles/api-designer.md) (lead): Conçoit le contrat d’interface, le modèle d’interaction, la cohérence et l’utilisabilité des capacités exposées.; suggested-answer-owner: [Canevas de conception de solution de capacité](https://apiopscycles.com/fr/resources/capability-solution-design-canvas.md)
- [Ingénieur automatisation](https://apiopscycles.com/fr/roles/automation-engineer.md) (lead): Met en œuvre, teste, intègre et exploite les solutions d’automatisation et les workflows associés.; suggested-answer-owner: [Canevas de workflow d’automatisation](https://apiopscycles.com/fr/resources/automation-workflow-canvas.md)
- [Architecte de la plateforme](https://apiopscycles.com/fr/roles/platform-architect.md) (core): Oriente les décisions relatives à la plateforme, à l’intégration, à l’évolutivité et à l’architecture qui déterminent comment la capacité ou l’API est construite et exploitée.
- [Expert du domaine](https://apiopscycles.com/fr/roles/domain-specialist.md) (core): Apporte une connaissance approfondie du domaine métier, des concepts, des règles et des contraintes que la capacité ou l’interface doit refléter.
- [Propriétaire du produit API](https://apiopscycles.com/fr/roles/api-product-owner.md) (core): Pilote l’opportunité API, la priorisation et les décisions au niveau produit tout au long du cycle de vie.
- [Représentant utilisateur API](https://apiopscycles.com/fr/roles/api-consumer-specialist.md) (core): Représente les besoins des développeurs, intégrateurs ou autres utilisateurs d'API qui utilisent l'API directement.
- [Responsable de capacité](https://apiopscycles.com/fr/roles/capability-owner.md) (core): Responsable de la vision, de la valeur, des priorités, du cycle de vie et de la réutilisation de la capacité auprès des utilisateurs.
- [Responsable de l'automatisation](https://apiopscycles.com/fr/roles/automation-owner.md) (core): Responsable des objectifs, de la valeur métier, des priorités, des contrôles et des résultats du cycle de vie de l’automatisation.
- [Responsable de processus](https://apiopscycles.com/fr/roles/process-owner.md) (core): Responsable du processus métier à automatiser, y compris les objectifs, les règles, les résultats et les priorités d’amélioration.
- [Spécialiste en conformité et juridique](https://apiopscycles.com/fr/roles/compliance-specialist.md) (core): Clarifie les exigences juridiques, de confidentialité, réglementaires et contractuelles qui affectent la capacité, l’API, l’interface ou l’automatisation.
- [Spécialiste en sécurité](https://apiopscycles.com/fr/roles/security-specialist.md) (core): Assure que les risques de sécurité, les contrôles et les limites de confiance sont pris en compte tout au long du cycle de vie.
- [Ingénieur de livraison](https://apiopscycles.com/fr/roles/api-engineer.md) (consulted): Assume la responsabilité de la mise en œuvre, de l’automatisation, des tests et du flux de publication nécessaires pour livrer la capacité, l’API ou l’automatisation de manière fiable.
- [Responsable Documentation & DevRel](https://apiopscycles.com/fr/roles/api-devrel-specialist.md) (consulted): Responsable des contenus d'onboarding, de la communication avec les développeurs et de la qualité de la documentation API.
- [Responsable métier](https://apiopscycles.com/fr/roles/business-owner.md) (consulted): Représente les objectifs métier, le financement et les résultats attendus de l’initiative de capacité, d’API ou d’automatisation.

## Cycle-specific guidance

- [Cycle de productisation des capacités](https://apiopscycles.com/fr/cycles/capability-productization-cycle/stations/api-design.md)
- [Cycle de productisation des API](https://apiopscycles.com/fr/cycles/api-productization-cycle/stations/api-design.md)
- [Cycle de productisation des capacités d’intégration](https://apiopscycles.com/fr/cycles/integration-productization-cycle/stations/api-design.md)
- [Cycle d’automatisation](https://apiopscycles.com/fr/cycles/automation-cycle/stations/api-design.md)