Support downloading excel and csv responses with content disposition attachment header #2274

LauraXiulan · 2023-08-16T14:48:49Z

When retrieving an CSV or EXCEL file as response in the Developer Portal, the response is shown inline, which makes it unreadable. This PR adds logic to download these kinds of responses instead.

Suggestions, remarks and edits are welcome. I tested the code locally for our own APIM by temporary switching to Self-Hosted.
I have only added CSV and EXCEL in this PR, but I can imagine a usecase for PDF's as well.

Azure#1584) * Create mainCI.yml Work in progress, don't merge * Update mainCI.yml * Update mainCI.yml * Update mainCI.yml * Update mainCI.yml * Update mainCI.yml * added script for build website * Update mainCI.yml * Update mainCI.yml * Update mainCI.yml * Update mainCI.yml * Update mainCI.yml * Update mainCI.yml * Update mainCI.yml * Fixed color contrast accessibility issues * Fixed ari-roles issues * added static storage wip * Added missing static data * Update mainCI.yml * added static data for requests made at publishing time * updated PublisherStaticDataProvider * updated PublisherStaticDataProvider * updated PublisherStaticDataProvider * get data from default.json too * added build-static-data script * refactoring * removed logs * removed some headers from static data * removed headers * added smaller GraphQL api * Update mainCI.yml * Update mainCI.yml * Update mainCI.yml * Update mainCI.yml * test accessibility on profile * Update mainCI.yml * Update mainCI.yml * removed headers * test with pre-populated e-mail and password * compacted json files * removed test e-mail and password * code review changes * test for signed in version * added default.json and defaultMockData.json only for staticData * fixed webpack configs * fixed accessibility issues * fixed accessibility issues * added staticDataEnviroment constant * Update mainCI.yml * removed logs * renamed defaultMockData.json

…ult template. (Azure#1669)

Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.7 to 1.14.8. - [Release notes](https://github.com/follow-redirects/follow-redirects/releases) - [Commits](follow-redirects/follow-redirects@v1.14.7...v1.14.8) --- updated-dependencies: - dependency-name: follow-redirects dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

@azaslonov

…enerate.js (Azure#1675) > @azaslonov Thank you for accepting the PR. Not sure why the build failed. It appears not related to my changes. Any insights? This is accessibility check, doesn't seem to be related to your PR. @malincrist, do you mind taking a look?

…1680)

…re#1685)

… other minor improvements (Azure#1681)

* Added support for union types in the graphql console * Removing hardcoding and using constant values from the graphql library

Implementation inspired by Azure#1621 Co-authored-by: Jonas Anker Rasmussen <[email protected]>

…Azure#1700)

* Add "API: Products (dropdown)" widget Closes Azure#1177 * Update src/components/apis/api-products/ko/runtime/api-products-dropdown.ts Avoid assigning undefined to undefined Co-authored-by: Rafał Mielowski <[email protected]> * Remove unnecessary function called in the next line by other function Co-authored-by: Rafał Mielowski <[email protected]>

… the "send" button from the test console (Azure#1704)

…zure#1705)

…zure#1713)

* Supporting graphql subscriptions * Adding improvements and style variables to the gql console.

…zure#2190) * Made page content section stretch by default for all viewport sizes * stretch by default for home layout as well

* Replace deprecated methods from cred generation Co-authored-by: Farhad Alizada <[email protected]>

…)" (Azure#2193) This reverts commit ef4b854.

* added pagination for user subscriptions * lint fix

* Fixed scroll to operation in operation details * use id instead of class; fixed for graphql

Co-authored-by: Farhad Alizada <[email protected]>

* Removed duplicated styles

* Add dropdown for the case when there are multiple examples --------- Co-authored-by: Farhad Alizada <[email protected]>

…est run (Azure#2209) * Remove no needed async and wait for the server listen event before test run * Listen to console errors in tests * Use node 18 * Add incognito option for browser * Clear user directory before test start --------- Co-authored-by: Farhad Alizada <[email protected]>

Co-authored-by: Alexander Zaslonov <[email protected]> Co-authored-by: Farhad Alizada <[email protected]>

Co-authored-by: Farhad Alizada <[email protected]>

* Add Playwright tests with image comparison for profile page --------- Co-authored-by: Farhad Alizada <[email protected]>

…attachment header.

LauraXiulan · 2023-08-16T14:58:19Z

@microsoft-github-policy-service agree

LauraXiulan · 2023-08-22T07:28:30Z

#1984

LauraXiulan · 2023-10-31T08:44:18Z

@ygrik @malincrist @azaslonov

verschaevesiebe · 2024-01-16T14:30:40Z

Nice addition, we sometimes have the intent to download other content types. Eg. a very large JSON file for example.
Would you be able to include a similar feature for attachment disposition types where filenames are json or by means any text formal is applicable ?

E.g xml, text, json, jsonc, etc ...

header('Content-Disposition: attachment; filename=data.json');
header('Content-Type: application/json');

Would be amazing thanks !

malincrist and others added 30 commits February 22, 2022 12:44

Added an input field for a hostname if it was not specified (Azure#1666)

df45107

Added options to show/hide code samples (Azure#1664)

96da0d2

Upgraded paperbits to v0.1.488 (Azure#1668)

d24a9ea

Added check for media files in a snapshot folder. Cleaned up the defa…

2d25366

…ult template. (Azure#1669)

Removed duplicate widget registration. (Azure#1679)

4281f86

Added Terms of Use to all authentication pages (Azure#1648)

20341ea

Fixed search by tag issues for "List of APIs (Tiles)" widget. (Azure#…

235936c

…1680)

Migrated developerPortalType from constants to settings provider (Azu…

e578b41

…re#1685)

Synchronized GraphQL parameters between query editor and explorer and…

b6349fd

… other minor improvements (Azure#1681)

Added support for union types in the graphql console (Azure#1688)

a007f4d

* Added support for union types in the graphql console * Removing hardcoding and using constant values from the graphql library

Fix AAD/B2C message shown on SignUp page error (Azure#1687)

c4207bd

Implementation inspired by Azure#1621 Co-authored-by: Jonas Anker Rasmussen <[email protected]>

Implemented support for complex schemas as a property (Azure#1694)

52b2665

custom-html widget iframe allow fix (Azure#1698)

07e2fd4

Temporarily removed authorization server info from operation details. (…

1729f8c

…Azure#1700)

Merged back fixes from managed version. (Azure#1702)

5cb43eb

When the oepration changes, while the next operation is loading, hide…

742102f

… the "send" button from the test console (Azure#1704)

removed duplicated call to /apis for the API list widget (Azure#1703)

d046ebe

Removed the check for the terms of use consent, since it's not used (A…

6c48c25

…zure#1705)

Upgraded dependencies. (Azure#1706)

34e7882

Check if onChange is defined before invoking it (Azure#1710)

cff22e4

Create SECURITY.md

5ca2eaa

Load API list when the API list dropdown widget is first initialized (A…

11db424

…zure#1713)

Fixing 'generate' command run instructions (Azure#1721)

1da7c6b

Upgraded dependencies. (Azure#1722)

f4c5ff5

markdownService processMarkdown - length as optional param (Azure#1724)

ed5bdae

Supporting Graphql Subscriptions (Azure#1723)

692e6f9

* Supporting graphql subscriptions * Adding improvements and style variables to the gql console.

malincrist and others added 20 commits May 31, 2023 16:14

Made page content section stretch by default for all viewport sizes (A…

f73c9b6

…zure#2190) * Made page content section stretch by default for all viewport sizes * stretch by default for home layout as well

Replace deprecated methods from cred generation (Azure#2192)

9993be4

* Replace deprecated methods from cred generation Co-authored-by: Farhad Alizada <[email protected]>

Revert "Added developer portal type header for all requests (Azure#2171…

6df1119

…)" (Azure#2193) This reverts commit ef4b854.

Added pagination for user subscriptions (Azure#2189)

2f6572a

* added pagination for user subscriptions * lint fix

Upgraded dependencies. (Azure#2191)

435f7b8

Fixed scroll to operation (Azure#2200)

53bfff2

* Fixed scroll to operation in operation details * use id instead of class; fixed for graphql

Increase dev-portal version to 2.24.0 (Azure#2199)

4cb0764

Co-authored-by: Farhad Alizada <[email protected]>

Upgrade paperbits to 0.1.587 (Azure#2204)

7977733

Co-authored-by: Farhad Alizada <[email protected]>

Removed duplicated styles (Azure#2206)

c2d53d5

* Removed duplicated styles

Removed menu styles from test console (Azure#2197)

72d11e5

Add dropdown for the case when there are multiple examples (Azure#2208)

518c428

* Add dropdown for the case when there are multiple examples --------- Co-authored-by: Farhad Alizada <[email protected]>

Subscription key improvements (Azure#2212)

2805ab9

fixed regex that extracts resource name (Azure#2205)

f299905

Upgraded dependencies and default theme. (Azure#2198)

9fe6440

Co-authored-by: Alexander Zaslonov <[email protected]> Co-authored-by: Farhad Alizada <[email protected]>

fix typos and spelling errors (Azure#2195)

255c87c

Updated widget registration model. (Azure#2235)

a0c75d7

Add navigation menu for default pages (Azure#2257)

d395754

Co-authored-by: Farhad Alizada <[email protected]>

Playwright tests (Azure#2254)

e350f81

* Add Playwright tests with image comparison for profile page --------- Co-authored-by: Farhad Alizada <[email protected]>

Support downloading excel and csv responses with content disposition …

add7c20

…attachment header.

optyingale approved these changes Oct 25, 2023

View reviewed changes

azaslonov force-pushed the master branch 4 times, most recently from 79dae19 to a74f7db Compare March 21, 2025 21:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support downloading excel and csv responses with content disposition attachment header #2274

Support downloading excel and csv responses with content disposition attachment header #2274

LauraXiulan commented Aug 16, 2023 •

edited

Loading

LauraXiulan commented Aug 16, 2023

LauraXiulan commented Aug 22, 2023

LauraXiulan commented Oct 31, 2023

verschaevesiebe commented Jan 16, 2024

Support downloading excel and csv responses with content disposition attachment header #2274

Are you sure you want to change the base?

Support downloading excel and csv responses with content disposition attachment header #2274

Conversation

LauraXiulan commented Aug 16, 2023 • edited Loading

LauraXiulan commented Aug 16, 2023

LauraXiulan commented Aug 22, 2023

LauraXiulan commented Oct 31, 2023

verschaevesiebe commented Jan 16, 2024

LauraXiulan commented Aug 16, 2023 •

edited

Loading