swagger-api / swagger-api/swagger-ui

Make your API public in production with OAuth 2

Open
#9,562 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

  • OS: macOS
  • Browser: Safari, Chrome... all
  • Version: all
  • Method of installation: dist
  • Swagger-UI version: Swagger UI v5.11.3
  • Swagger/OpenAPI version: Swagger 3.0, OpenAPI 3.1

Hello everyone,

This question does not concern any technical problem but just a question of practice.

Let me explain ;)

I want to expose my API to the public (NelmioApiDocBundle Symfony with Swagger) provided I have an OAuth 2.0 client with Authorization Code flow + PKCE registered in my authorization server.

I have a question regarding Swagger UI and the ability for users to test by clicking "Authorize".

My API only allows OAuth 2 authentication.

Should I create a Client just for the API or leave it free to enter the client ID.

The client has its own "redirect_uri" necessarily... will this work on the API documentation?

For my tests I implemented an oauth-redirect.html file. I think it is not necessary in production? The URI used will be the one registered for the client trying to connect?

I try to understand because I'm not going to configure 2 redirect-uris per client (one for its client application and one to test the API) ?

How to ensure you have the correct redirect uri from Client App. The input box does not exist ?

Thanks for your help,

Sébastien

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the OAuth 2 Authorization Code flow with PKCE and the mentioned oauth-redirect.html file in the context of Swagger UI. Clarify whether production API testing should use a dedicated client and redirect URI, and document the expected redirect URI behavior when the issue's questions have a decided answer.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi
Domain
api, authentication, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.