Pixiu HTTP To Dubbo

pixiu-http-to-dubbo

Purpose

Generate a complete or embeddable api_config.yaml, and add the required companion conf.yaml fragments.

When to use

• Use when:

  • Creating or modifying HTTP-to-Dubbo routes, including registry/direct mode switching, parameter mapping, type conversion, generic-invoke config, or debugging errors such as no provider found, ClassNotFound, empty responses, and signature mismatches.

• Do not use for:

  • New registry adapter implementation or non-Dubbo HTTP proxy routes.

Inputs

<HARD-GATE>
Do not generate YAML, write code, create files, or take any implementation action until the user has provided all required inputs. This is a first principle.

If any required input is missing, this turn must only ask for the missing fields in the current input group; do not generate examples, defaults, YAML, code, or final output.

Even if configuration information seems inferable, obvious, or implied by context, you must still ask the user to confirm it. Do not proceed until the user confirms it. </HARD-GATE>

• Choose Dubbo provider mode (required):
  • Required:
    • provider_mode: registry or direct
• listener (required):
  • Defaults:
    • address.socket_address.address: 0.0.0.0
    • address.socket_address.port: 8888
• route_config (required):
  • Defaults:
    • routes[].match.prefix: /api/v1
    • routes[].route.cluster: dubbo-route
• dgp.filter.http.apiconfig (required):
  • Defaults:
    • config.path: configs/api_config.yaml
    • config.dynamic: false
• dgp.filter.http.dubboproxy (required):
  • Defaults:
    • dubboProxyConfig.timeout_config.connect_timeout: 5s
    • dubboProxyConfig.timeout_config.request_timeout: 5s
    • dubboProxyConfig.load_balance: roundrobin
    • dubboProxyConfig.retries: "3"
• api_config.yaml resource/method (required):
  • Required:
    • resources[].path
    • methods[].httpVerb
    • integrationRequest.interface
    • integrationRequest.method
  • Optional:
    • resources[].description
    • integrationRequest.group
    • integrationRequest.version
    • integrationRequest.applicationName
    • integrationRequest.clusterName
  • Defaults:
    • resources[].type: restful
    • resources[].timeout: 1000ms
    • methods[].enable: true
    • methods[].timeout: 1000ms
    • inboundRequest.requestType: http
    • integrationRequest.requestType: dubbo
• Dubbo method parameters (required when the method has parameters):
  • Required:
    • mappingParams[] using exactly one argument style:
      • positional mappings: mappingParams[].mapTo: "0", "1", ...
      • opt.values mappings: map request fields to opt.values, and map or declare Java types separately when needed
  • Conditionally required:
    • opt.types when using opt.values and Java types cannot be inferred or must be explicit.
    • parameterTypes[] for direct-mode positional mappings, or whenever Java types must override inferred types.
    • When method parameters contain POJOs, nested objects, or collections, provide the corresponding Java class names and field types.
• Registry provider (required when provider_mode: registry; defaults use Zookeeper, Nacos can also be chosen, examples below use Zookeeper):
  • Required:
    • dubboProxyConfig.registries.zookeeper.address
  • Optional:
    • dubboProxyConfig.registries.zookeeper.group
    • dubboProxyConfig.registries.zookeeper.namespace
    • dubboProxyConfig.registries.zookeeper.username
    • dubboProxyConfig.registries.zookeeper.password
  • Defaults:
    • dubboProxyConfig.registries.zookeeper.protocol: zookeeper
    • dubboProxyConfig.registries.zookeeper.registry_type: interface
    • dubboProxyConfig.registries.zookeeper.timeout: 3s
    • dubboProxyConfig.registries.zookeeper.group: DEFAULT_GROUP
• Direct provider (required when provider_mode: direct):
  • Required:
    • integrationRequest.url
  • Conditionally required:
    • integrationRequest.parameterTypes (use [] for no-argument methods; required when opt.types is not used)
  • Optional:
    • integrationRequest.protocol (needed when url is host:port; when url has a scheme, it must match that scheme)
  • Defaults:
    • integrationRequest.protocol: dubbo
    • integrationRequest.serialization: hessian2