常见问题¶
为什么这里没有登录入口?¶
因为当前需求是接口文档展示,不是团队知识库。
这套站点刻意保持“打开即看”,不引入工作区、邮箱、权限后台这些额外机制。
为什么不是 Swagger 风格在线调试?¶
现阶段目标是先把项目里已有文档整理成统一、清晰、可公开访问的说明站,而不是先做在线请求台。
为什么还保留了一些脚本和 Redis 结构说明?¶
因为你的项目不只是对外 HTTP API,还包含:
- WebSocket 推送
- 数据采集脚本
- Redis 临时结构
- 策略字段说明
- 迁移和运维说明
这些内容如果全删掉,接口使用者会缺关键上下文。
后续最值得补什么?¶
- 把最核心的接口逐页拆开重写
- 为重点接口补齐统一的
200 / 400 / 401 / 403 / 404示例 - 给每页增加更细的字段表、业务限制和 FAQ
这套接口文档公开后会有人需要吗?¶
会,有需求,而且和 AkShare、TuShare 不是同一类需求。
- 如果对方已经是 Python 研究者,直接用
AkShare或TuShare往往更快。 - 如果对方是前端、移动端、Java / Go / PHP 后端,或者要做多系统接入,他们通常更需要这种标准化的 HTTP / WSS 接口文档。
- 如果对方不想先理解 Python SDK、积分权限、数据清洗和本地落库流程,而是只想“拿到地址就接”,这种公开文档就更有价值。
更直接地说,这套站点适合的是“接口消费者”,而不只是“数据研究者”。