swagger-api / swagger-api/swagger-ui

swagger-ui page hangs for large response

Open
#8,260 1 comment 0 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: Windows
  • Browser: chrome
  • Version: 104.0.xxxxxxxx
  • Method of installation: war
  • Swagger-UI version: 1.6.9
  • Swagger/OpenAPI version: Open API 3.0
Content & configuration

I'm unable to provide yaml here as Im currently outside my citrix envt.
However, the issue is that when I try out an API, swagger-UI hangs for large json response. Takes around 30 mins to complete one request which used to be around 6 seconds with the old version of SpringFox-swagger-ui.

I tried to set springdoc:swagger-ui:syntax-highlight to False but this property is ignored.

Example Swagger/OpenAPI definition:

# your YAML here

Swagger-UI configuration options:

SwaggerUI({
  // your config options here
})
?yourQueryStringConfig
Describe the bug you're encountering
To reproduce...

Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error
Expected behavior
Screenshots
Additional context or thoughts

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

No source file or test is identified. Start by reproducing the Swagger UI request with a large JSON response in Chrome and compare behavior with syntax highlighting disabled; the issue is done when the response completes promptly and the syntax-highlight configuration is honored.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, performance
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.