Swagger hangs and never returns data from query

Henrik_Haumann · October 20, 2022, 10:49am

Hello

I have a problem with a request that never finishes and returns data.

When I use the REST debugger in Delphi it returns data just fine, is there a limitation of the number of json lines that swagger can handle?

wlandgraf · October 20, 2022, 1:24pm

Yes, Google indicates that it's a know problem in Swagger UI when handling big responses:

github.com/swagger-api/swagger-ui

Large response bodies cause hanging

opened 05:10AM - 28 Oct 17 UTC

shockey

type: bug P2 version: 3.x

| Q | A | ------------------------------- | -----…-- | Bug or feature request? | Bug | Which Swagger/OpenAPI version? | 2.0 | Which Swagger-UI version? | 3.4.0 | How did you install Swagger-UI? | local dev server | Which browser & version? | Chrome 61 | Which operating system? | macOS High Sierra ### Demonstration API definition Swagger 2 Petstore is sufficient. ### Configuration (browser query string, constructor, config.yaml) Default. ### Current Behavior As an example, `GET /pet/findByStatus` in the Petstore currently returns 1.8MB of JSON when all statuses are selected. This is a pretty big chunk of data, but Swagger-UI insists on rendering the _entire_ body, which is neither performant or useful. The main thread of the application is locked for upwards of 20 seconds on my machine. ### Possible Solution Truncate or refuse to display large textual response bodies. ### Context `GET /pet/findByStatus` is my favorite operation to use when testing UI enums, so this is something that impedes me pretty regularly.

github.com/swagger-api/swagger-ui

Swagger UI freezes when processing a 1.5MB response

opened 05:09PM - 29 Nov 21 UTC

ppazos

### Q&A (please complete the following information) - OS: Linux Mint 19.3 - …Browser: Firefox 90.0 and Chromium 95.0 - Method of installation: dist assets - Swagger-UI version: 4.1.0 - Swagger/OpenAPI version: OpenAPI 3.0 ### Content & configuration [openapi2.json.txt](https://github.com/swagger-api/swagger-ui/files/7619806/openapi2.json.txt) The path GET /definition/template/adl1.4/{template_id} retrieves an XML that is 1.5 MB long. Swagger-UI configuration options: ```js window.onload = function() { // Begin Swagger UI call region const ui = SwaggerUIBundle({ url: "/assets/openapi2.json", dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis//, //SwaggerUIStandalonePreset // commented to remove the topbar plugin ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ]//, //layout: "StandaloneLayout" // commented to remove the topbar plugin }); // End Swagger UI call region window.ui = ui; }; ``` ### Describe the bug you're encountering Call to the endpoint freezes the whole page and stays in "LOADING" forever. ![Screenshot_2021-11-29_14-03-18](https://user-images.githubusercontent.com/1278556/143911375-0dee1da2-ca61-4e8c-b226-d3616be42a66.png) In the JS console I see this trace from highlight.js: ``` Script terminated by timeout at: O@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:182485 C@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:182558 R<@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:185916 oi@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:790540 qi@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:800058 Hu@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:843753 Os@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:829987 ks@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:829915 Ss@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:829776 vs@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:826763 Jo/<@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:776435 t.unstable_runWithPriority@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:853474 Wo@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:776212 Jo@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:776382 $o@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:776315 gs@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:827084 notify@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:252413 O</t.notifyNestedSubs@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:253048 O</t.handleChangeWrapper@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:253116 p@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:946287 Ce/</</<@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:61301 $/<@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:946718 ze/</<@http://localhost:8095/assets/swagger-ui-bundle.js?compile=false:2:89982 ``` Maybe this is not a swagger-ui issue per se, it seems the highlight lib doesn't have the power to handle the big XML. Can highlight be disabled to test? ### To reproduce... The API is not public so it can't be reproduced publicly. Internally what I do is: 1. Invoke the authentication endpoint 2. Copy the token to the AUTHORIZATION button 3. Invoke the list templates endpoint 4. Copy the template id from the response 5. Invoke the get template endpoint with the template id 6. Everything freezes ### Expected behavior Avoid freezing. ### Screenshots See above. ### Additional context or thoughts Allow to disable the response highlight to test.