spring-cloud / spring-cloud/spring-cloud-gateway

IDLFilter: A Custom Filter for Detecting and Explaining Inter-Parameter Dependencies in Web APIs

Open
#3,642 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

waiting for votes
Dominant language
Java
Stars
4.9k
Forks
3.5k
Avg merge
20h 57m
Merged PRs (30d)
8

Description

Is your feature request related to a problem? Please describe.
Web APIs often include inter-parameter dependencies [1] that constrain how input parameters can be combined to form valid service calls.

Violating inter-parameter dependencies leads to:

  • Unnecessary message exchanges, resulting in wasted time and excessive quota usage.
  • Ambiguous error messages or failures due to insufficient validation of input requests, making debugging and resolution challenging.

Describe the solution you'd like
We propose the integration of IDLFilter [2], a custom filter for Spring Cloud Gateway, designed to:

  • Detect and explain inter-parameter dependency violations in Web APIs.
  • Leverage the Inter-parameter Dependency Language (IDL) to specify parameter constraints [3, 4].
  • Utilize IDLReasoner, a constraint-based analysis engine, to enforce these constraints effectively [3, 4].

IDLFilter

Key Benefits

  • Enhanced error messaging: Informative and actionable error responses for invalid API calls.
  • Robust input validation: Reduces the likelihood of failures caused by dependency violations.
  • Improved performance:
    • A 59% reduction in response time for invalid requests.
    • Only a minimal 7% overhead for valid requests.

Evaluation Results

  • Tested with 12 industrial API operations and ~30K API calls (manual and automated).
  • Results show that IDLFilter effectively blocks invalid API calls and provides detailed explanations for violations.

References
1- Martin-Lopez, A., Segura, S., Ruiz-Cortés, A. (2019). A Catalogue of Inter-parameter Dependencies in RESTful Web APIs. Springer Link
2- IDLFilter: GitHub Repository
3- Barakat, S., Martin-Lopez, A., Müller, C., Segura, S., & Ruiz-Cortés, A. (2025). The IDL Tool Suite: Specifying and Analyzing Inter-Parameter Dependencies in Web APIs. ScienceDirect
4- IDLWebsite: http://idl.us.es

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked IDLFilter repository and the Spring Cloud Gateway project context, focusing on how IDL, IDLReasoner, and custom filters are expected to integrate. Done would mean a defined Gateway integration that detects and explains inter-parameter dependency violations, with validation of the reported performance and API-call results.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring, spring-boot
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.