[PR #2680] feat: support HTTP response compression in api server #23779

Closed
opened 2026-02-21 20:21:45 -05:00 by yindo · 0 comments
Owner

Original Pull Request: https://github.com/langgenius/dify/pull/2680

State: closed
Merged: Yes


Description

  • Support response compression in api module on demand, if Accept-Encoding header in request is set to gzip or br
  • content compression helps to reduce the traffic impact when the browser accessing API modules, considering ~100KB response content respond for pulling model providers, tool providers and etc, will be shrinked down to ~20KB
  • The reverse proxy like nginx will bypass the content from API module if they are properly compressed avoiding repeated compression
  • flask-compress module is used, docs and available options refer to : https://github.com/colour-science/flask-compress
  • Introduce API_COMPRESSION_ENABLED env to control whether enable response compresson
  • Compress the following MIME types by default:
    • 'application/json'
    • 'application/javascript',
    • 'text/css'
    • 'text/html'
    • 'text/javascript'
    • 'text/xml'
  • taking /console/api/workspaces/current/model-providers for example, transferred size gets down from 112KB to 7.6KB
    image

Type of Change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update, included: Dify Document

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • TODO

Suggested Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods
  • optional I have made corresponding changes to the documentation
  • optional I have added tests that prove my fix is effective or that my feature works
  • optional New and existing unit tests pass locally with my changes
**Original Pull Request:** https://github.com/langgenius/dify/pull/2680 **State:** closed **Merged:** Yes --- # Description - Support response compression in api module on demand, if `Accept-Encoding` header in request is set to `gzip` or `br` - content compression helps to reduce the traffic impact when the browser accessing API modules, considering ~100KB response content respond for pulling model providers, tool providers and etc, will be shrinked down to ~20KB - The reverse proxy like nginx will bypass the content from API module if they are properly compressed avoiding repeated compression - `flask-compress` module is used, docs and available options refer to : https://github.com/colour-science/flask-compress - Introduce `API_COMPRESSION_ENABLED` env to control whether enable response compresson - Compress the following MIME types by default: - 'application/json' - 'application/javascript', - 'text/css' - 'text/html' - 'text/javascript' - 'text/xml' - taking `/console/api/workspaces/current/model-providers` for example, transferred size gets down from 112KB to 7.6KB ![image](https://github.com/langgenius/dify/assets/1935105/a1cdadae-ab7d-4275-9237-5f53329f0681) ## Type of Change Please delete options that are not relevant. - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs) # How Has This Been Tested? Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - [ ] TODO # Suggested Checklist: - [x] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] My changes generate no new warnings - [x] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods - [ ] `optional` I have made corresponding changes to the documentation - [ ] `optional` I have added tests that prove my fix is effective or that my feature works - [ ] `optional` New and existing unit tests pass locally with my changes
yindo added the pull-request label 2026-02-21 20:21:45 -05:00
yindo closed this issue 2026-02-21 20:21:45 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#23779