@dsaid/swagger-ui-plugin-otp-auth

This is a OTP authentication plugin for [Swagger UI](https://swagger.io/docs/open-source-tools/swagger-ui/customization/plugin-api/).

unpublished

latest

Source

npm

Version: 0.0.2

Version published: 3 years ago

Weekly downloads: 0

Maintainers: 1

Weekly downloads

Created: 3 years ago

Source

@dsaid/swagger-ui-plugin-otp-auth

This is a OTP authentication plugin for Swagger UI.

Prerequisites

Install

$ npm install @dsaid/swagger-ui-plugin-otp-auth

Usage

import OtpAuthPlugin from '@dsaid/swagger-ui-plugin-otp-auth'

// swagger-ui initialization
  SwaggerUI({
    plugins: [
      OtpAuthPlugin,
      ...
    ]
  })

Swagger Configuration

components:
  securitySchemes:
    OtpAuth:
      # base config
      type: http
      scheme: bearer
      otp: true
      # token url
      tokenUrl: /api/otp/
      # request path and method
      requestOtpPath: /new
      requestOtpMethod: post 
      requestOtpQuery:
        service: service-name
      # auth path and method
      authPath: /authenticate
      authMethod: post
      authQuery:
        service: service-name
        expiry: 10800

security:
  - OtpAuth: []

FAQs

What is @dsaid/swagger-ui-plugin-otp-auth?

Is @dsaid/swagger-ui-plugin-otp-auth popular?

Is @dsaid/swagger-ui-plugin-otp-auth well maintained?

Package last updated on 05 May 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install