SecurityBadge

Domain · API Doc

Inline badge representing an API security scheme type with a matching icon and color.

Preview

BearerAuth ApiKey OAuth2 OpenID mTLS

Code

<%- include('modules/domain/api-doc/SecurityBadge', { type: 'http',   name: 'BearerAuth' }) %>
<%- include('modules/domain/api-doc/SecurityBadge', { type: 'apiKey', name: 'ApiKey' }) %>
<%- include('modules/domain/api-doc/SecurityBadge', { type: 'oauth2', name: 'OAuth2' }) %>

<%
  var _type      = locals.type || 'apiKey';
  var _name      = locals.name || null;
  var _className = locals.className || '';

  var schemeConfig = {
    apiKey:        { label: 'API Key',        icon: 'fa-solid fa-key',         style: 'bg-warning-subtle text-warning-fg border-warning/30' },
    http:          { label: 'HTTP',           icon: 'fa-solid fa-lock',        style: 'bg-info-subtle text-info-fg border-info/30' },
    oauth2:        { label: 'OAuth 2.0',      icon: 'fa-solid fa-shield',      style: 'bg-primary-subtle text-primary border-primary/30' },
    openIdConnect: { label: 'OpenID Connect', icon: 'fa-solid fa-fingerprint', style: 'bg-success-subtle text-success-fg border-success/30' },
    mutualTLS:     { label: 'Mutual TLS',     icon: 'fa-solid fa-id-card',     style: 'bg-surface-sunken text-text-secondary border-border' },
  };

  var config      = schemeConfig[_type] || schemeConfig['apiKey'];
  var displayName = _name || config.label;
%>

  
  <%= displayName %>

SecurityBadge

Scheme types