swagger-api / swagger-api/swagger-ui

Support syntaxHighlight prop in swagger-ui-react

Open
#8,404 4 comments 11 reactions 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

Q&A (please complete the following information)
  • OS: MacOS
  • Browser: Chrome
  • Version: 110.0.5481.100
  • Method of installation: npm i swagger-ui-react
  • Swagger-UI version: 4.15.5
  • Swagger/OpenAPI version: OpenAPI 3.0
Content & configuration

Swagger-UI configuration options:

import Swagger from "swagger-ui-react"
import "swagger-ui-react/swagger-ui.css"

const RenderSwaggerUI = () =>{
   return <Swagger
      key={SWAGGER_URL}
      url={SWAGGER_URL}
      deepLinking
      syntaxHighlight={false}
    />
}
Describe the bug you're encountering

Because syntaxHighlight prop is not supported by swagger-ui-react, the agate theme is always used by default for syntax highlighting.

Expected behavior

Support syntaxHighlight prop in swagger-ui-react

Additional context or thoughts

The swagger page becomes unresponsive when syntax highlighting is enabled and the response payload is huge (swagger-ui open issues related to this #8260 #3832 ). Workaround for this is to disable the syntax highlighting by setting the syntaxHighLight prop to false.

Since swagger-ui already supports configuring this prop, I believe appending the following line to constructor block in swagger-ui-react should do the trick.

// Modify the https://github.com/swagger-api/swagger-ui/blob/master/flavors/swagger-ui-react/index.jsx

const ui = swaggerUIConstructor({
...,
syntaxHighlight: this.props.syntaxHighlight
})

SwaggerUI.propTypes = {
syntaxHighlight: PropTypes.oneOfType([ PropTypes.bool, PropTypes.object ]),
}

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 in flavors/swagger-ui-react/index.jsx, especially the SwaggerUI constructor block and the component's propTypes. Trace how existing props reach the Swagger UI constructor, then verify that the documented syntaxHighlight prop is accepted and configured as described; the issue provides no test path, so check the package's existing test setup for validation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
frontend
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.