Qeasy Cloud
Get Started

Business Data Modeling (Response Data Strict Mode) Configuration Guide

· 陈洁琳· Product Docs· 10 views· 3 min read

Feature Overview

When designing the interface scheduling capabilities of Qeasy DataHub, we frequently encountered a recurring issue: downstream business systems are highly sensitive to parameter types. For example, they expect to receive integer timestamps, boolean flags, and floating-point amounts. If the caller passes values as strings, implicit conversion exceptions often surface at runtime, and the troubleshooting cost is significant.

【Business Data Modeling (Response Data Strict Mode)】 is designed precisely to address this pain point. It lives in the 【Interface Information View】 of the Request Scheduler and is exposed as an 【Enable Data Modeling】 toggle.

The core value of this feature lies in three aspects:

  • Strict Type Validation: Once enabled, the platform performs rigorous data type checks on request parameters during the scheduling stage. Integers must be integers, floats must be floats, and booleans must be booleans.
  • Default Fallback Behavior: When disabled, all request data is forwarded as the String type by default, preserving compatibility with legacy systems that rely on loose typing.
  • Reduced Integration Cost: Pre-validation replaces post-incident troubleshooting, dramatically reducing integration failures caused by type mismatches.

Use Cases

Typical use scenarios include:

  1. Interfacing with Strongly-Typed Backend Services: When downstream systems are built with strongly-typed languages such as Java, Go, or .NET, API fields are type-sensitive. Enabling data modeling prevents confusion between strings and numeric values.
  2. Transmitting Critical Fields Like Amounts and Timestamps: Amount fields must be floating-point or high-precision numeric types; timestamps must be long integers. Both can be automatically validated once the feature is enabled.
  3. Transmitting Switch and Status Flags: Boolean fields (e.g., enabled/disabled) are easily passed as the strings "true" or "false" in loosely-typed environments. Strict mode forces proper validation.
  4. Multi-Source Data Aggregation Scenarios: In DataHub's multi-source aggregation scenarios, different data sources may define types inconsistently. Strict mode unifies the outbound type contract.

Configuration Guide

The configuration path is straightforward and can be completed in three steps:

  1. Navigate to the 【Request Scheduler】 module.
  2. Select the target interface from the left navigation and open the 【Interface Information View】.
  3. Locate the 【Enable Data Modeling】 toggle within the Interface Information View and switch it to ON.

Once enabled, the platform reads the data model definitions already configured for the interface and validates type consistency before dispatching the request. If a parameter does not match the model, the platform returns a clear error message instead of silently performing implicit conversion.

Important Considerations

We have summarized several points that require special attention based on real-world usage:

  • Impact on Existing Interfaces: Enabling data modeling on a stable, running interface constitutes a behavioral change. It is recommended to first verify in a test environment whether existing callers are affected by the new type validation.
  • Relationship with Field Mapping: Data modeling governs types only, not value mappings. For field transformation, combine it with the field mapping capabilities of Qeasy DataHub.
  • Rollback Path: If compatibility issues arise after enabling, the toggle can be switched off at any time, and request data will revert to the string pass-through mode.
  • Prerequisite Model Definition: Before enabling data modeling, ensure the field definitions of the data model are in place at the interface layer; otherwise the platform cannot perform type validation.
  • Log Observability: Once enabled, Qeasy outputs type validation failure details in the scheduling logs to facilitate caller-side troubleshooting.

By using the strict mode of Business Data Modeling appropriately, Qeasy can maintain a stable, predictable, and type-consistent interface contract in multi-system integration, significantly reducing the hidden risks of cross-system integration.

Original content. Please credit the source when reposting: https://www.qeasy.cloud/insights/product-docs/doc-n5443a92d

Comments