Azure / Azure/azure-functions-openapi-extension

Feature Request: SwaggerUI Auth Options

Open
#389 11 comments 5 reactions 0 assignees View on GitHub
discussion enhancement
Dominant language
C#
Stars
388
Forks
202
PR merge metrics
No merged PRs in 30d

Description

**Describe the issue**
[SwashBuckle.ASpDotnetCore](https://github.com/domaindrivendev/Swashbuckle.AspNetCore#enable-oauth20-flows) Provides built-in UI support for for OAuth 2.0 flows that help developers quickly stand up Swagger UIs with data pre-filled in, such as OAuth ClientIds, etc. This also reduces the amount configuration the user needs to do per function and would reduce the developer's need to copy and paste this information from another source.

Would it be possible for this to support such functionality or would that fall out of scope for the intended use of the extension?

If not, since SwashBuckle is not compatible with Az Functions, do you have a suggested way I might pre-full this?

**Screenshots**
For example, with SwashBuckle, I can configure The SwaggerUI such that the API itself can fill this out without the user needing to copy and paste these kinds of secrets from elsewhere:
![image](https://user-images.githubusercontent.com/75496244/158886392-d51e6af2-c40c-489a-a93b-246f111e2467.png)

Contributor guide

Open the contributing guide

Research direction

No source files or tests are named. Start by reviewing the Azure Functions OpenAPI extension's Swagger UI configuration and the linked Swashbuckle OAuth 2.0 flow documentation; first clarify which OAuth options should be supported and how values should be supplied, then define completion as an agreed, testable configuration behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, csharp, openapi
Domain
api, cloud
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.