MadJax
9d2b676c84
Nouvelle fonctionnalité : consulter les documents de spécification (exigences,
conception technique, plan de tâches) en lecture seule dans le frontend.
Backend :
- SpecsController (GET /api/specs, GET /api/specs/{cle}) protégé par l'auth
globale ; SpecDocumentService avec whitelist (pas de path traversal) et
lecture depuis le dossier specs/ embarqué, repli sur .kiro/specs en dev.
- DTOs SpecDocumentDto / SpecContenuDto ; service enregistré dans Program.cs.
Docker :
- Contexte de build backend = racine du dépôt (dockerfile: backend/Dockerfile)
pour embarquer .kiro/specs/*.md dans l'image (app autonome).
- .dockerignore racine ajouté (exclut frontend/node_modules, bin/obj, etc.).
Frontend :
- SpecService + SpecsComponent (lazy-loadé) : page dédiée avec menu latéral par
document ; rendu Markdown via marked (GFM) assaini par DOMPurify.
- Diagrammes Mermaid (ex. graph TB) rendus en SVG via mermaid.js importé
dynamiquement ; déclenchement après résolution du @ViewChild (setTimeout).
- Barre de navigation : simple lien « Specs » (le choix du document se fait dans
le menu latéral de la page, pas dans la barre).
- Routes /specs et /specs/:cle protégées par authGuard.
Specs : exigence 19 (consultation des documents) ajoutée à requirements.md ;
design.md complété (DTOs, endpoints, composant, rendu Mermaid, note Docker).
51 lines
1.9 KiB
C#
51 lines
1.9 KiB
C#
using Microsoft.AspNetCore.Mvc;
|
|
using SchotzIadKmTracker.Api.Models.DTOs;
|
|
using SchotzIadKmTracker.Api.Services;
|
|
|
|
namespace SchotzIadKmTracker.Api.Controllers;
|
|
|
|
/// <summary>
|
|
/// Expose en lecture seule les documents de spécification du projet (exigences,
|
|
/// conception technique, plan de tâches) pour affichage dans le frontend. Comme tous
|
|
/// les controllers hors AuthController, ces endpoints exigent un utilisateur
|
|
/// authentifié (autorisation globale) : les specs ne sont pas publiques.
|
|
/// </summary>
|
|
[ApiController]
|
|
[Route("api/specs")]
|
|
public class SpecsController : ControllerBase
|
|
{
|
|
private readonly ISpecDocumentService _specDocumentService;
|
|
|
|
public SpecsController(ISpecDocumentService specDocumentService)
|
|
{
|
|
_specDocumentService = specDocumentService;
|
|
}
|
|
|
|
/// <summary>Liste les documents de spécification connus et leur disponibilité (pour le sous-menu).</summary>
|
|
[HttpGet]
|
|
[ProducesResponseType(typeof(IReadOnlyList<SpecDocumentDto>), StatusCodes.Status200OK)]
|
|
public ActionResult<IReadOnlyList<SpecDocumentDto>> Lister()
|
|
{
|
|
return Ok(_specDocumentService.Lister());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Retourne le contenu Markdown d'un document identifié par sa clé (whitelist :
|
|
/// "requirements", "design", "tasks"). 404 si la clé est inconnue ou le fichier absent.
|
|
/// </summary>
|
|
[HttpGet("{cle}")]
|
|
[ProducesResponseType(typeof(SpecContenuDto), StatusCodes.Status200OK)]
|
|
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
|
public async Task<ActionResult<SpecContenuDto>> Obtenir(string cle, CancellationToken cancellationToken)
|
|
{
|
|
var contenu = await _specDocumentService.ObtenirAsync(cle, cancellationToken);
|
|
if (contenu is null)
|
|
{
|
|
return Problem(
|
|
detail: $"Le document de spécification '{cle}' est introuvable.",
|
|
statusCode: StatusCodes.Status404NotFound);
|
|
}
|
|
return Ok(contenu);
|
|
}
|
|
}
|