oauth2.spec-enhancer.ts

import { bind } from "@loopback/core";
import {
  asSpecEnhancer,
  mergeOpenAPISpec,
  OASEnhancer,
  OpenApiSpec,
  OpenAPIObject
} from "@loopback/rest";

const authServerUrl = process.env.AUTH_SERVER_URL;
const tokenUrl = `${authServerUrl}/oauth/token`;
const authorizationUrl = `${authServerUrl}/oauth/authorize`;

const OAuth2Spec: Partial<OpenAPIObject> = {
  components: {
    securitySchemes: {
      OAuth2: {
        type: "oauth2",
        description: "OAuth 2.0 flows",
        flows: {
          authorizationCode: {
            authorizationUrl,
            tokenUrl,
            scopes: {}
          },
          implicit: {
            authorizationUrl,
            scopes: {}
          },
          clientCredentials: {
            tokenUrl,
            scopes: {}
          },
          password: {
            tokenUrl,
            scopes: {}
          }
        }
      }
    }
  },
  security: [
    {
      OAuth2: []
    }
  ]
};

@bind(asSpecEnhancer)
export class OAuth2SpecEnhancer implements OASEnhancer {
  name = "OAuth2";

  modifySpec(spec: OpenApiSpec): OpenApiSpec {
    return mergeOpenAPISpec(spec, OAuth2Spec);
  }
}