OAuth2 and Bearer Authorization

[credas-dev]

Is there way to configure swagger for different types of security?

I found a discussion here that we could configure security in the format below.

const swaggerOptions = {
  swaggerDefinition: {
    openapi: '3.0.1', // YOU NEED THIS
    info: {
      title: 'Your API title',
      version: '1.0.0',
      description: 'Your API description'
    },
    basePath: '/',
    components: {
      securitySchemes: {
        bearerAuth: {
          type: 'http',
          scheme: 'bearer',
          bearerFormat: 'JWT',
        }
      }
    },
    security: [{
      bearerAuth: []
    }]
  },
  apis: ['/some/path.js|yml'],
};

I'm using NextJS 12 and configuring my docs using the code below.

import { withSwagger } from "next-swagger-doc";

const swaggerHandler = withSwagger({
  definition: {
    openapi: "3.0.0",
    info: {
      title: "OTLS-API",
      version: "1.39.0",
    },
  },
  apiFolder: "pages/api",
});
export default swaggerHandler();

I wasn't able to configure a security parameter in the definition. Is there an example of how I can do this?

[jellydn]

Hi @credas-dev
I've tried this yet but I think this should work.

import { withSwagger } from "next-swagger-doc";

const swaggerHandler = withSwagger({
  definition: {
    openapi: "3.0.0",
    info: {
      title: "OTLS-API",
      version: "1.39.0",
    },
    // Add Auth 
     components: {
      securitySchemes: {
        bearerAuth: {
          type: 'http',
          scheme: 'bearer',
          bearerFormat: 'JWT',
        }
      }
    },
    security: [{
      bearerAuth: []
    }]
  },
  apiFolder: "pages/api",
});

[jmsolutionsgroup]

@jellydn
I created a sample repo using a modified version of the sample that is provided with version v.0.3.6.

I'm still not getting the prompt or an area for a bearer token. Can you see if something is wrong?

[jellydn]

Hi @uchetfield I've added a example on this repo for your question.

Let me know if you have any questions.

[jellydn]

You could refer to this commit for usage 1a5a08e
Demo link: https://next-swagger-doc-demo.productsway.com/api-doc

[jmsolutionsgroup]

Thank you for the update. What would be the correct way to set the oauth2RedirectUrl?