RicoSuter/NSwag

Support preauthorizeApiKey in SwaggerUi3

Open

#2,431 opened on Sep 27, 2019

View on GitHub
 (3 comments) (3 reactions) (0 assignees)C# (1,189 forks)batch import
help wantedproject: swagger-uitype: enhancement

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

When using ApiKey authorization, it would be nice if you wouldn't have to enter the apikey manually into SwaggerUi each time (when developing)

SwaggerUi has a feature for this: preauthorizeApiKey.

Seems feasible to implement by adding a new property SwaggerUi3Settings and then inject in the index.html in TransformHtml, just like it's done now for the OAuth2ClientSettings.

Contributor guide

Research direction
Implement preauthorizeApiKey support by adding a new property to SwaggerUi3Settings and modifying the TransformHtml method to inject the preauthorizeApiKey JavaScript configuration, similar to how OAuth2ClientSettings is handled. Ensure the configuration is passed to the Swagger UI initialization script.
Tech stack
csharpjavascript
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Swagger UI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70