cloudflare / chanfana

OpenAPI 3 and 3.1 schema generator and validator for Hono, itty-router and more!
https://chanfana.pages.dev
MIT License
263 stars 35 forks source link

Love Chanfana but is this possible? (Nested routes description) #158

Open agotfredsen82 opened 2 weeks ago

agotfredsen82 commented 2 weeks ago

Hi love Chanfana, great work.

We have v1 and v2 nested routes working side by side and both are added to the base/root router and would be beyond awesome if both could have description in the root .. like a summary root docs describing both v1 and v2 somehow if its even a part of openapi ??? I have no clue ...

when doing this we get root.com/docs and then we get individual docs for root.com/v1/docs and root.com.com/v2/docs and that is awesome .. but the root.com/docs don´t clearly describe v1 and v2 its just one big thing .. so how do you or others handle this .. ? of you want a root docs that describe that you have multiply version endpoints , or maybe it is beyond the scope of openapi ?

const router_v1 = fromIttyRouter(Router({ base: "/v1" }), { base: "/v1", schema: { info: { title: "API 1", description: "Backend 1 .", version: "v1.0.2", }, }, });

const router_v2 = fromIttyRouter(Router({ base: "/v2" }), { base: "/v2", schema: { info: { title: "API 2", description: "Backend 2 .", version: "v1.0.1", }, }, });