Merge pull request #137 from kravetsone/main

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

Author: marclave

bun.lockb

@@ -110,8 +110,10 @@ export const swagger = async <Path extends string = '/swagger'>(
 
 		if (routes.length !== totalRoutes) {
 			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({

src/index.ts

@@ -118,7 +118,7 @@ export const registerSchemaPath = ({
 	models: Record<string, TSchema>
 }) => {
 	if (hook) hook = deepClone(hook)
-
+		
 	const contentType = hook?.type ?? [
 		'application/json',
 		'multipart/form-data',

src/utils.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();
+	})
 })