Add custom components, security for OpenAPI (#296)

Urigo · Mar 11, 2020 · 6870fe8 · 6870fe8
1 parent 167097c
commit 6870fe8
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -272,6 +272,49 @@ app.use(
 openApi.save('./swagger.yml');
 ```
 
+OpenAPI (Swagger) with Bearer Authentication
+
+```ts
+import { useSofa, OpenAPI } from 'sofa-api';
+
+const openApi = OpenAPI({
+  schema,
+  info: {
+    title: 'Example API',
+    version: '3.0.0',
+  },
+  components: {
+    securitySchemes: {
+      bearerAuth: {
+        type: 'http',
+        scheme: 'bearer',
+        bearerFormat: 'JWT',
+      },
+    },
+  },
+  security: [
+    {
+      bearerAuth: [],
+    },
+  ],
+});
+
+app.use(
+  '/api',
+  useSofa({
+    schema,
+    onRoute(info) {
+      openApi.addRoute(info, {
+        basePath: '/api',
+      });
+    },
+  })
+);
+
+// writes every recorder route
+openApi.save('./swagger.yml');
+```
+
 ## License
 
 [MIT](https://github.com/Urigo/sofa/blob/master/LICENSE) © Uri Goldshtein
diff --git a/src/open-api/index.ts b/src/open-api/index.ts
@@ -15,9 +15,13 @@ import { OpenAPI } from './interfaces';
 export function OpenAPI({
   schema,
   info,
+  components,
+  security,
 }: {
   schema: GraphQLSchema;
   info: Record<string, any>;
+  components?: Record<string, any>;
+  security?: Record<string, any>[];
 }) {
   const types = schema.getTypeMap();
   const swagger: any = {
@@ -40,6 +44,14 @@ export function OpenAPI({
     }
   }
 
+  if (components) {
+    swagger.components = { ...components, ...swagger.components };
+  }
+
+  if (security) {
+    swagger.security = security;
+  }
+
   return {
     addRoute(
       info: RouteInfo,