Download binary response file from Laravel API

[Vitolete]

Scribe version

4.37

Your question

Hello, I just wanted to know if there is any way to download a zip file that comes in binary format and is obtained from a Laravel API response using response()->download().

I have tried doing it with FileSaver and transforming it to a Blob, but the downloaded files are corrupted.

return preflightPromise.then(() => makeAPICall(method, path, body, query, headers, endpointId))
                    .then(([responseStatus, statusText, responseContent, responseHeaders]) => {
                        responsePanel.hidden = false;
                        responsePanel.querySelector(`.response-status`).textContent = responseStatus + " " + statusText ;

                        let contentEl = responsePanel.querySelector(`.response-content`);
                        if (responseContent === '') {
                            contentEl.textContent = contentEl.dataset.emptyResponseText;
                            return;
                        }

                        const blob = new Blob([responseContent], { type: 'application/zip' });
                        saveAs(blob, 'file.zip');

                        // Prettify it if it's JSON
                        let isJson = false;
                        try {
                            const jsonParsed = JSON.parse(responseContent);
                            if (jsonParsed !== null) {
                                isJson = true;
                                responseContent = JSON.stringify(jsonParsed, null, 4);
                            }
                        } catch (e) {}

                        contentEl.innerHTML = responseContent;
                        isJson && window.hljs.highlightElement(contentEl);
                    })
                    .catch(err => {
                        console.log(err);
                        let errorMessage = err.message || err;
                        errorPanel.hidden = false;
                        errorPanel.querySelector(`.error-message`).textContent = errorMessage;
                    })
                    .finally(() => { btnElement.disabled = false } );

In Swagger there's an option that creates a link to download the file, and it works correctly.

Thank you and best regards.

Docs

• I've checked the docs, the troubleshooting guide, and existing issues, but I didn't find a solution

[shalvah]

Hey, don't know if you still need this, but my guess is that if you're doing this based on responseContent , it's possible the response body might already have been decoded as text, hence the corruption. You may need to capture the raw response bytes.

[shalvah]

Just checked, and yes, that's what's happening. In makeAPICall, we call Response.text() on the fetch response, which decodes it as a UTF-8 string.

scribe/resources/js/tryitout.js

Line 126 in a26d9c9

.then(response => Promise.all([response.status, response.statusText, response.text(), response.headers]));

If you want the raw body, you need to edit this to response.blob().

[shalvah]

What you mentioned about providing the option to download sounds like a good feature. I can't commit to making any changes to this right now, though. Please send in a PR if you can!