feat: exclude routes with details.hide: true from OpenAPI/swagger file

src/index.ts

@@ -112,6 +112,8 @@ export const swagger = async <Path extends string = '/swagger'>(
 			totalRoutes = routes.length
 			
 			routes.forEach((route: InternalRoute) => {
+				if (route.hooks?.detail?.hide === true) return
+				// TODO: route.hooks?.detail?.hide !== false  add ability to hide: false to prevent excluding
 				if (excludeMethods.includes(route.method)) return
 
 				registerSchemaPath({

test/index.test.ts

@@ -200,4 +200,23 @@ describe('Swagger', () => {
 		const response = await res.json()
 		expect(response.paths).toContainKey('/id/{id}')
 	})
+
+	it('should hide routes with hide = true from paths', async () => {
+		const app = new Elysia().use(swagger())
+			.get("/public", "omg")
+			.guard({
+				detail: {
+					hide: true
+				}
+			})
+			.get("/hidden", "ok")
+
+		await app.modules
+
+		const res = await app.handle(req('/swagger/json'))
+		expect(res.status).toBe(200)
+		const response = await res.json()
+		expect(response.paths['/public']).not.toBeUndefined();
+		expect(response.paths['/hidden']).toBeUndefined();
+	})
 })