feat(apis): ajout champs de documentation enrichie sur les API entries
- Nouveaux champs : functionalDoc, technicalDoc, externalDocUrl, contactFunctional, contactTechnical, accessRights - Entity, DTOs, service et seeder mis à jour côté backend - Page upload et api-detail mis à jour côté frontend Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
This commit is contained in:
@@ -1,6 +1,7 @@
|
||||
import { Injectable, OnApplicationBootstrap } from '@nestjs/common';
|
||||
import { InjectRepository } from '@nestjs/typeorm';
|
||||
import { Repository } from 'typeorm';
|
||||
import * as fs from 'fs/promises';
|
||||
import { ApiEntryEntity } from '../apis/api-entry.entity';
|
||||
import { CategoryEntity } from '../categories/category.entity';
|
||||
import { DocsGenerationService } from '../docs-generation/docs-generation.service';
|
||||
@@ -595,11 +596,26 @@ export class SeederService implements OnApplicationBootstrap {
|
||||
) {}
|
||||
|
||||
async onApplicationBootstrap(): Promise<void> {
|
||||
const forceReseed = process.env.FORCE_RESEED === 'true';
|
||||
if (forceReseed) {
|
||||
await this.reset();
|
||||
}
|
||||
const count = await this.apiRepo.count();
|
||||
if (count > 0) return; /* Idempotent — ne ré-exécute pas si des données existent */
|
||||
await this.seed();
|
||||
}
|
||||
|
||||
private async reset(): Promise<void> {
|
||||
/* Supprimer toutes les entrées puis les catégories */
|
||||
await this.apiRepo.delete({});
|
||||
await this.categoryRepo.delete({});
|
||||
/* Nettoyer le répertoire docs-output */
|
||||
const docsDir = process.env.DOCS_OUTPUT_DIR ?? '/app/docs-output';
|
||||
await fs.rm(docsDir, { recursive: true, force: true });
|
||||
await fs.mkdir(docsDir, { recursive: true });
|
||||
console.log('[Seeder] Reset complet — données supprimées, docs nettoyées.');
|
||||
}
|
||||
|
||||
private async seed(): Promise<void> {
|
||||
/* Catégories racines */
|
||||
const ecommerce = await this.categoryRepo.save(
|
||||
@@ -680,6 +696,12 @@ export class SeederService implements OnApplicationBootstrap {
|
||||
yamlContent: PETSTORE_YAML,
|
||||
status: 'PENDING',
|
||||
categoryId: produits.id,
|
||||
functionalDoc: 'Cas d\'usage : gestion du catalogue produits. Permet de lister, créer et consulter des animaux de compagnie. Usage typique : intégration e-commerce, démo API REST.',
|
||||
technicalDoc: 'Authentification Bearer token requise. Pagination via paramètre `limit` (max 100). Réponses JSON selon schéma OpenAPI 3.0. Endpoint base : https://petstore.swagger.io/v3.',
|
||||
externalDocUrl: null,
|
||||
contactFunctional: 'Équipe Produit',
|
||||
contactTechnical: 'Équipe API',
|
||||
accessRights: 'API publique — aucune habilitation requise.',
|
||||
}),
|
||||
this.apiRepo.create({
|
||||
title: 'Streetlights Kafka API',
|
||||
@@ -690,6 +712,12 @@ export class SeederService implements OnApplicationBootstrap {
|
||||
yamlContent: STREETLIGHTS_YAML,
|
||||
status: 'PENDING',
|
||||
categoryId: evenements.id,
|
||||
functionalDoc: 'Gestion de l\'éclairage urbain IoT. Permet de recevoir les mesures de luminosité des lampadaires et d\'envoyer des commandes d\'allumage/extinction à distance.',
|
||||
technicalDoc: 'Broker Kafka sécurisé avec SCRAM-SHA-512. Topics : smartylighting.streetlights.1.0.*. Schémas de messages définis en AsyncAPI 3.0. Adresse broker : test.mykafkacluster.org:18092.',
|
||||
externalDocUrl: null,
|
||||
contactFunctional: 'Bureau Infrastructure',
|
||||
contactTechnical: 'ops@example.com',
|
||||
accessRights: 'Accès sur demande — habilitation DSI requise.',
|
||||
}),
|
||||
this.apiRepo.create({
|
||||
title: 'Account Service',
|
||||
@@ -699,6 +727,12 @@ export class SeederService implements OnApplicationBootstrap {
|
||||
yamlContent: ACCOUNT_SERVICE_YAML,
|
||||
status: 'PENDING',
|
||||
categoryId: notifications.id,
|
||||
functionalDoc: 'Cycle de vie du compte utilisateur. Publie des événements lors de l\'inscription et du changement de mot de passe. Utilisé par les services de notification et d\'audit.',
|
||||
technicalDoc: 'Consommer via broker AMQP ou Kafka. Canaux : user/signedup, user/passwordchanged. Payloads JSON avec horodatage ISO 8601. Spec AsyncAPI 3.0.',
|
||||
externalDocUrl: null,
|
||||
contactFunctional: 'Équipe Comptes',
|
||||
contactTechnical: 'dev-core@example.com',
|
||||
accessRights: 'Interne uniquement — accès réservé aux services du SI.',
|
||||
}),
|
||||
this.apiRepo.create({
|
||||
title: 'Orders API',
|
||||
@@ -708,6 +742,12 @@ export class SeederService implements OnApplicationBootstrap {
|
||||
yamlContent: ORDERS_YAML,
|
||||
status: 'PENDING',
|
||||
categoryId: commandes.id,
|
||||
functionalDoc: 'Gestion des commandes clients : création, consultation, mise à jour du statut. Supporte les webhooks pour les transitions de statut (confirmed, shipped, delivered, cancelled).',
|
||||
technicalDoc: 'REST + JWT Bearer. Pagination via paramètres `page` et `limit`. Webhook de statut : POST vers URL configurée lors de la transition. Base URL : https://api.example.com/v1.',
|
||||
externalDocUrl: null,
|
||||
contactFunctional: 'Équipe Commerce',
|
||||
contactTechnical: 'api-orders@example.com',
|
||||
accessRights: 'Partenaires agréés uniquement — convention de partenariat requise.',
|
||||
}),
|
||||
this.apiRepo.create({
|
||||
title: 'Auth API',
|
||||
@@ -717,6 +757,12 @@ export class SeederService implements OnApplicationBootstrap {
|
||||
yamlContent: AUTH_YAML,
|
||||
status: 'PENDING',
|
||||
categoryId: auth.id,
|
||||
functionalDoc: 'SSO centralisé avec tokens JWT. Gère la connexion, le rafraîchissement de token et la déconnexion. Exposé à tous les services du SI comme fournisseur d\'identité.',
|
||||
technicalDoc: 'Bearer JWT (RS256). Endpoint principal : POST /auth/login. Refresh via POST /auth/refresh. Durée access token : 15 min. Durée refresh token : 7 jours. Base URL : https://auth.example.com/v1.',
|
||||
externalDocUrl: null,
|
||||
contactFunctional: 'Équipe Sécurité',
|
||||
contactTechnical: 'securite@example.com',
|
||||
accessRights: 'Restreint — habilitation RSSI requise avant intégration.',
|
||||
}),
|
||||
]);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user