swagger-api / swagger-api/swagger-ui
Swagger page failing to load for API endpoints with large JSON responses
Open
Nobody has claimed this yet.
type: bug
version: 5.x
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Example Swagger/OpenAPI definition:
openapi.yaml.zip
I am using Quarkus 3.5.0 (OpenAPI 3.0.3) embedded swagger, When dealing with API endpoints, due to large json response that gets populated in example schema section, the UI is crashing. Attaching the openapi definition. Please let me know if any other information is needed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by unpacking openapi.yaml.zip and reproducing the crash in Swagger UI with the large response examples described in the issue. Trace the page-loading failure from that reproduction; done means the supplied OpenAPI definition loads without the UI crashing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- api, frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100