How can I represent ‘Authorization: Bearer ‘ in a Swagger Spec (swagger.json)

by

Maybe this can help:

swagger: '2.0'
info:
  version: 1.0.0
  title: Based on "Basic Auth Example"
  description: >
    An example for how to use Auth with Swagger.

host: basic-auth-server.herokuapp.com
schemes:
  - http
  - https
securityDefinitions:
  Bearer:
    type: apiKey
    name: Authorization
    in: header
paths:
  /:
    get:
      security:
        - Bearer: []
      responses:
        '200':
          description: 'Will send `Authenticated`'
        '403': 
          description: 'You do not have necessary permissions for the resource'

You can copy&paste it out here: http://editor.swagger.io/#/ to check out the results.

There are also several examples in the swagger editor web with more complex security configurations which could help you.

More Related Contents:

  1. How to return an array of objects in SwaggerHub?
  2. How to document dynamic query parameter names in OpenAPI (Swagger)?
  3. How to define a mixed-type array (with different element types) in OpenAPI 2.0?
  4. Swagger schema properties ignored when using $ref – why?
  5. Swagger 2.0: Multiple Path objects with different paths but same request and response
  6. Swagger/OpenAPI – use $ref to pass a reusable defined parameter
  7. Swagger complex response model with dynamic key value hash maps
  8. Swagger: wildcard path parameters
  9. Swagger: “equivalent path already exists” despite different parameters
  10. How to write OpenAPI 3 (Swagger) specification for property name in `map` object?
  11. How to format Swagger 2.0 text descriptions?
  12. Schema object without a type attribute in Swagger 2.0
  13. Swagger: take one or more values from enum
  14. How to export swagger.json (or yaml)
  15. Swagger: How to have a property reference a model in OpenAPI 2.0 (i.e. nest the models)?
  16. How to specify if a field is optional or required in OpenAPI/Swagger?
  17. Swagger Inheritance and Composition
  18. Swagger/OpenAPI mock server
  19. How to define a property that can be string or null in OpenAPI (Swagger)?
  20. How to define mutually exclusive query parameters in Swagger (OpenAPI)?
  21. Use object type query param in swagger documentation
  22. How to convert OpenAPI 2.0 to OpenAPI 3.0? [closed]
  23. How to define an optional parameter in path using swagger
  24. Swagger API which is having query string
  25. How to configure Spring Security to allow Swagger URL to be accessed without authentication
  26. Re-using model with different required properties
  27. How not to copy-paste 3 generic error responses in almost all paths?
  28. Combining defintions in Swagger docs
  29. How to define global parameters in OpenAPI?
  30. How to change Swagger-ui URL prefix?

Leave a Comment