swagger-api / swagger-api/swagger-ui

`swagger-ui-react`: Customize components of swagger-ui

Open
#5,258 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Content & configuration

We'd love to switch to swagger-ui-react but are depending upon customizing certain components of swagger-ui. Is this possible in swagger-ui-react?

Swagger-UI config here: https://github.com/awslabs/aws-api-gateway-developer-portal/blob/master/dev-portal/src/pages/Apis.jsx#L35

Custom Plugin here: https://github.com/awslabs/aws-api-gateway-developer-portal/blob/master/dev-portal/src/components/SwaggerUiLayout.jsx#L18

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

Review the referenced dev-portal/src/pages/Apis.jsx and dev-portal/src/components/SwaggerUiLayout.jsx files to understand the Swagger UI configuration and custom plugin usage. Compare those requirements with the swagger-ui-react integration, then define whether component customization is supported and what a completed change or documentation update would need to demonstrate.

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.