swagger-api / swagger-api/swagger-ui

Need help with requestInterceptor in react app

Open
#5,241 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Q&A (please complete the following information)
  • OS: [macOS]
  • Browser: [chrome, firefox]
  • Version: [22]
  • Method of installation: [npm]
  • Swagger-UI version: [3.21.0]
  • Swagger/OpenAPI version: [Swagger 2.0]
Content & configuration

I am trying to consume https://www.npmjs.com/package/swagger-ui-react in my app to render api doc and need to supply custom Authorization header and also replace model and parameter macros when swagger Ui renders. Need guide or help on how to go about them.

Swagger/OpenAPI definition:

# your YAML here

Swagger-UI configuration options:

SwaggerUI({
  // your config options here
})
?yourQueryStringConfig
Screenshots
How can we help?

I am trying to consume https://www.npmjs.com/package/swagger-ui-react in my app to render api doc and need to supply custom Authorization header and also set model and parameter macros. Need guide or help on how to go about them. Can you provide any examples where swagger-ui-react component is being used with above said usages.

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 swagger-ui-react package and its configuration documentation; the issue names no repository files or tests. Document examples for supplying a custom Authorization header and configuring model and parameter macros, with completion defined by clear usage guidance for both cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.