Skip to content

Add OpenAPI documentation#10

Draft
gerald-lbn wants to merge 3 commits intomainfrom
feat/openapi
Draft

Add OpenAPI documentation#10
gerald-lbn wants to merge 3 commits intomainfrom
feat/openapi

Conversation

@gerald-lbn
Copy link
Member

This PR add supports for the OpenAPI documentation.
It generates the documentation upon starting the application with bun run dev

The OpenAPI documentation is available at /openapi.

In order to successfully generate the docs. I had to remove "bun-types" from the tsconfig.json.

Closes #8

image

@gerald-lbn gerald-lbn requested a review from clembs November 24, 2025 00:05
Copy link
Member

@clembs clembs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mais on a besoin de bun-types pour utiliser les utilitaires de Bun de façon type-safe ? pourquoi les retirer ?

@gerald-lbn
Copy link
Member Author

La génération du site echoue si je laisse bun-types dans le fichier de configuration tsconfig.json

@gerald-lbn
Copy link
Member Author

Comme ça
image

@clembs
Copy link
Member

clembs commented Nov 27, 2025

Apparemment le générateur de types avec fromTypes déconne à cause de la version d'Elysia (cf. elysiajs/elysia-openapi#279). On peut le retirer et expliciter le type des requêtes à la main en utilisant des schémas TypeBox.

@clembs clembs marked this pull request as draft November 30, 2025 19:02
@clembs
Copy link
Member

clembs commented Nov 30, 2025

Il faudrait réécrire les routes existantes pour typer leurs réponses

@clembs clembs added type: enhancement Nouvelle fonctionnalité ou demande scope: apps/backend API PNS labels Dec 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope: apps/backend API PNS type: enhancement Nouvelle fonctionnalité ou demande

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ajout de la documentation OpenAPI

2 participants

Comments