Add missing OAS related opts

Urigo · May 5, 2023 · 61e0494 · 61e0494
1 parent cd2a801
commit 61e0494
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/.changeset/purple-worms-care.md b/.changeset/purple-worms-care.md
@@ -0,0 +1,5 @@
+---
+'sofa-api': patch
+---
+
+Add missing options for OAS
diff --git a/src/router.ts b/src/router.ts
@@ -105,10 +105,13 @@ export function createRouter(sofa: Sofa) {
 
   const router = createRouterInstance<any>({
     base: sofa.basePath,
+    components,
     title: sofa.title || 'SOFA API',
     description: sofa.description || 'Generated by SOFA',
     version: sofa.version || '0.0.0',
-    components,
+    oasEndpoint: sofa.oasEndpoint,
+    swaggerUIEndpoint: sofa.swaggerUIEndpoint,
+    swaggerUIOpts: sofa.swaggerUIOpts,
   });
 
   const queryType = sofa.schema.getQueryType();

diff --git a/src/sofa.ts b/src/sofa.ts
@@ -15,6 +15,7 @@ import { convertName } from './common';
 import { logger } from './logger';
 import { ErrorHandler } from './router';
 import { HTTPMethod, StatusCode } from 'fets/typings/typed-fetch';
+import { SwaggerUIOpts } from 'fets/typings/plugins/openapi';
 
 // user passes:
 // - schema
@@ -55,9 +56,13 @@ export interface SofaConfig {
   context?: ContextFn | ContextValue;
   customScalars?: Record<string, any>;
   enumTypes?: Record<string, any>;
+  // OAS Related Settings
   title?: string;
-  version?: string;
   description?: string;
+  version?: string;
+  oasEndpoint?: string | false;
+  swaggerUIEndpoint?: string | false;
+  swaggerUIOpts?: SwaggerUIOpts;
 }
 
 export interface Sofa {
@@ -73,9 +78,13 @@ export interface Sofa {
   contextFactory: ContextFn;
   customScalars: Record<string, any>
   enumTypes: Record<string, any>
+  // OAS Related Settings
   title?: string;
-  version?: string;
   description?: string;
+  version?: string;
+  oasEndpoint?: string | false;
+  swaggerUIEndpoint?: string | false;
+  swaggerUIOpts?: SwaggerUIOpts;
 }
 
 export function createSofa(config: SofaConfig): Sofa {