swagger-api / swagger-api/swagger-ui

Support for customisation in swagger-ui-react?

Open
#5,367 8 comments 17 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cat: customization type: feature
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: All
  • Browser: All
  • Version: 3.x
  • Method of installation: npm
  • Swagger-UI version: 3.x
  • Swagger/OpenAPI version: OAS 3.0
How can we help?

Support for configuration in swagger-ui-react? Would like to be able to use a customised layout of swagger-ui within a react appliction with try out enabled. Issue #4745 seems to be fixed in swagger-ui-react but doesn't allow configuration. Is there any recommended way to have a customised layout within a react app? @shockey

Alternatively are there any timelines for the support of custom plugins in swagger-ui-react?

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 integration and the behavior discussed in issue #4745. Determine the intended configuration or custom-plugin surface for a customized layout with Try It Out enabled, then verify the resulting React usage against the requested Swagger UI and OpenAPI versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
frontend
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.