Skip to content

Clarifier le rôle de Swagger/Swagger-UI #1997

@StephaneTrebel

Description

@StephaneTrebel

Surtout dans le cadre de la transition Server->NestJS

Actuellement, /swagger-ui est exposé côté server et dans la cadre de la transition vers NestJS on a écarté le sujet (dit autrement, on migrera toute la route d'un coup quand on décomissionnera server).

Mais à l'aune de la transition, plusieurs questions se posent:

  • Est-ce qu'on garde Swagger-UI (ou plutôt OpenAPI UI) ?
  • Pourquoi faire ?
  • Pour qui ?
  • Comment on documente ça ?
  • Quel est son cycle de vie (initialisation, mise à jour, annotations, tests E2E, etc.)
  • Est-ce qu'on doit le prendre en compte pendant la transition Server->NestJS
  • et tout autre question philosophique qui serait pertinente…

NOTE: Grafana aussi expose son swagger sans qu'on ait décidé si on l'accepte ou non.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions