Annotate basicAuth security scheme in OpenAPI

Author: Aleksi Pekkala

src/api/controllers/PetController.ts

@@ -2,7 +2,7 @@ import { IsNotEmpty, IsNumber, IsUUID, ValidateNested } from 'class-validator';
 import {
     Authorized, Body, Delete, Get, JsonController, OnUndefined, Param, Post, Put
 } from 'routing-controllers';
-import { ResponseSchema } from 'routing-controllers-openapi';
+import { OpenAPI, ResponseSchema } from 'routing-controllers-openapi';
 
 import { PetNotFoundError } from '../errors/PetNotFoundError';
 import { Pet } from '../models/Pet';
@@ -32,6 +32,7 @@ class CreatePetBody extends BasePet {
 
 @Authorized()
 @JsonController('/pets')
+@OpenAPI({ security: [{ basicAuth: [] }] })
 export class PetController {
 
     constructor(

src/api/controllers/UserController.ts

@@ -3,7 +3,7 @@ import { IsEmail, IsNotEmpty, IsUUID, ValidateNested } from 'class-validator';
 import {
     Authorized, Body, Delete, Get, JsonController, OnUndefined, Param, Post, Put, Req
 } from 'routing-controllers';
-import { ResponseSchema } from 'routing-controllers-openapi';
+import { OpenAPI, ResponseSchema } from 'routing-controllers-openapi';
 
 import { UserNotFoundError } from '../errors/UserNotFoundError';
 import { User } from '../models/User';
@@ -41,6 +41,7 @@ class CreateUserBody extends BaseUser {
 
 @Authorized()
 @JsonController('/users')
+@OpenAPI({ security: [{ basicAuth: [] }] })
 export class UserController {
 
     constructor(

src/loaders/swaggerLoader.ts

@@ -22,9 +22,21 @@ export const swaggerLoader: MicroframeworkLoader = (settings: MicroframeworkSett
             refPointerPrefix: '#/components/schemas/',
         });
 
-        const swaggerFile = routingControllersToSpec(getMetadataArgsStorage(), {}, {
-            components: { schemas },
-        });
+        const swaggerFile = routingControllersToSpec(
+            getMetadataArgsStorage(),
+            {},
+            {
+                components: {
+                    schemas,
+                    securitySchemes: {
+                        basicAuth: {
+                            type: 'http',
+                            scheme: 'basic',
+                        },
+                    },
+                },
+            }
+        );
 
         // Add npm infos to the swagger doc
         swaggerFile.info = {