Skip to content

Croupier Python SDK 约定规范

命名约定

函数 ID 使用 resource.operation[namespace.]resource.operation

python
"player.get"
"player.ban"
"game.player.ban"

注册约定

所有函数必须在 connect() 前完成注册:

python
client.register_function(descriptor, handler)
client.connect()

描述符建议

最小可注册字段:

  • id
  • version

建议补齐基础说明:

  • summary
  • description
  • tags
  • input_schema
  • output_schema

建议补齐业务与治理信息:

  • resource
  • operation
  • capability
  • risk
  • enabled
  • permission

语义约束:

  • operation 是业务操作 key,例如 bangrantsend
  • SDK descriptor 不提供页面 schema、组件树、页面 mapping、菜单、分类显示名、页面标题、按钮文案或页面位置。
  • 动态分类、页面标题、按钮文案和页面位置只在 PageSpec / Page Studio 中确定,不写入 SDK descriptor,也不写入前端静态 locale 文件。
  • capability 只允许受控资源语义:collection_query/item_query/create/update/delete/action/task/report;它不是页面类型或按钮位置。
  • 默认 PageProposal 由 Server 根据 FunctionContract、JSON Schema、CapabilitySemantics 和 diagnostics 生成;SDK 不提供列、mapping、菜单或 UI。

完整契约见 OpenAPI / SDK Descriptor v2