Integration Backstage¶

Cette documentation et l'API sont declarees pour le portail Backstage.

TechDocs¶

Le site est genere avec MkDocs + le plugin techdocs-core, compatible Backstage TechDocs. Le fichier catalog-info.yaml (racine du depot) reference la doc :

annotations:
  backstage.io/techdocs-ref: dir:.

Catalogue (Component + API)¶

catalog-info.yaml declare : - un Component boaz-housing (le service), - une API boaz-housing-api de type openapi, pointant le schema OpenAPI du backend (https://api-housing.boaz-study.tech/openapi.json).

Ajouter au catalogue Backstage¶

Dans Backstage : Create -> Register an existing component -> URL du catalog-info.yaml sur la branche main. Backstage decouvre alors le composant, l'API et la documentation.

[Backstage addon]