Accueil › Fullstack Angular + Spring Boot › Générer les types TypeScript depuis OpenAPI
Générer les types TypeScript depuis OpenAPI
Faire tourner les deux ensembleintermediaire
Recopier les DTO à la main dans des interfaces TypeScript marche — jusqu'au jour où un champ est renommé côté back et que personne ne prévient le front. La chaîne de génération rend ce changement visible à la compilation.
Côté back, springdoc expose la description sans code supplémentaire :
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version><!-- version compatible Spring Boot 3 --></version>
</dependency>
GET /v3/api-docs renvoie alors le contrat complet, déduit des contrôleurs, des record et des annotations de validation.
Côté front, un générateur en fait des types :
// package.json
{
"scripts": {
"api:generer": "openapi-generator-cli generate -i http://localhost:8080/v3/api-docs -g typescript-angular -o src/app/api --additional-properties=fileNaming=kebab-case"
}
}
Le résultat est importable directement, et un champ supprimé côté back casse le tsc :
import { CommandeDto, CommandesService } from './api';
export class CommandesComponent {
private api = inject(CommandesService);
protected commandes = toSignal(this.api.lister(), { initialValue: [] });
}
Les termes à connaître
- OpenAPI
Format de description d'une API HTTP (anciennement Swagger) : chemins, paramètres, schémas de corps, codes de réponse. C'est le contrat sous forme lisible par une machine, donc exploitable pour générer du code.
- springdoc-openapi
Bibliothèque qui produit la description OpenAPI d'une application Spring Boot à partir du code existant : contrôleurs, DTO, annotations de validation. Exposée sur
/v3/api-docs(et/v3/api-docs.yaml), avec une interface d'exploration sur/swagger-ui.html.- Code-first / contract-first
Code-first : le contrat est généré depuis le code Java, qui reste la référence. Contract-first : le fichier OpenAPI est écrit (ou négocié) d'abord, et sert à générer les deux côtés. Le second convient quand plusieurs équipes doivent s'accorder avant de coder.
- Génération de client
Production automatique, depuis la description OpenAPI, des interfaces TypeScript et parfois des services d'appel. Supprime la recopie manuelle des DTO et fait apparaître les changements de contrat comme des erreurs de compilation.
- Dérive de contrat (contract drift)
Écart entre ce que le back renvoie réellement et ce que le front croit recevoir. Invisible à la compilation quand les types sont écrits à la main, elle se manifeste en production par un
undefinedinattendu.- Code généré versionné
Choix de committer le code généré plutôt que de le produire à chaque build. Rend les changements de contrat visibles dans la revue de code (le diff montre exactement ce qui bouge), au prix d'une étape de régénération à ne pas oublier.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.