API Explorer(OpenAPI / Swagger)¶
下面是 QuantumAtlas server 全部 /api endpoint 的交互式 OpenAPI 文档。它由
swaggo 从服务端代码注解
(internal/routes/openapi.go)自动生成,与 REST API 总览
那张手维护的表同源互补:这里给出完整的参数 / 请求体 / 响应 schema,可展开浏览、
全文搜索。
想实际调用(Try it out)?
本页是 Read the Docs 上的静态文档镜像,与 API server 不同源,已禁用
"Try it out"。要在线点测请用 server 自带的 Swagger UI(与 API 同源、host
正确、点 Authorize 填 Bearer <token> 即可带鉴权调写口)—— 浏览器
打开你部署的 https://<your-server>/swagger/ 即可。
spec 怎么保持同步
单一数据源是 internal/apidocs/swagger.json(pixi run swagger 生成、编译进
二进制)。文档构建时由 hooks/openapi_spec.py 拷进本页渲染,不另存提交副本;
CI(pixi run swagger-check)对注解与 spec 做 generate-and-diff 防漂移。
详见 REST API 总览 › 交互式 API 文档。