Forum Discussion

abhisingh03's avatar
abhisingh03
Occasional Visitor
4 years ago

I want to add authorize header in swagger document

I want to add a bearer JWT auth in my swagger API documentation but I am not able to do that. Please help me in doing this.
Swagger UI
ponelat's avatar
ponelat
Staff
4 years ago

OpenAPI 3.x supports JWT as a bearer format, but so far it's mostly for documentation purposes. Not sure how well tools handle it.

You can see an example here: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#jwt-bearer-sample

 

A minimal example: https://app.swaggerhub.com/apis/ponelat/example-jwt/1.0.0

Or inlined...

openapi: 3.0.3
info:
  title: Minimal
  version: 1.0.0
components:
  securitySchemes:
    FooSecurity:
      type: http
      scheme: bearer
      bearerFormat: JWT
paths: 
  /foo: 
    get:
      security: 
      - FooSecurity: []
      description: Get a bunch of Foos
      responses:
        200:
          description: A bunch of Foos