API REFERENCE / V0.5.3

稳定、可审计的模块接口

页面与外部调用复用同一套 Pydantic 输入契约和确定性计算服务。 计算成功会返回不可变快照链接;HTML 与 PDF 报告只读取该快照,不重新计算。

ENDPOINTS

平台接口目录

12 个公开路由 · 路由与基础 envelope 以 OpenAPI JSON 为准, 模块字段、必填性和单位以模块 schema 接口为准。

GET /

Home Page

GET /api/v1/calculations/{calculation_id}

按计算 ID 读取已保存快照,不重新执行公式。

GET /api/v1/calculations/{calculation_id}/report.pdf

生成或读取同源 PDF 工程报告。

GET /api/v1/modules

发现已注册模块、软件入口与工程发布状态。

POST /api/v1/modules/{module_id}/calculations

严格校验输入,执行确定性计算并保存不可变快照。

GET /api/v1/modules/{module_id}/schema

读取模块输入契约、中文标签、单位和验证算例。

GET /calculations/{calculation_id}/report

读取快照并呈现同源 HTML 工程报告。

GET /health/live

进程存活探针。

GET /health/ready

模块注册表和数据库就绪探针。

GET /modules/{module_id}

Module Page

GET /robots.txt

Robots

GET /sitemap.xml

Sitemap

QUICK START

推荐调用顺序

  1. 01

    发现模块读取模块 ID、页面入口和工程发布状态。

  2. 02

    读取契约取得必填字段、严格类型、单位与显示元数据。

  3. 03

    创建快照提交 {"input": {...}},保存返回的计算 ID。

  4. 04

    读取报告使用响应中的 HTML / PDF 链接复核同源结果。