2026年了,我们该如何产出API文档?
· 阅读需 2 分钟
2026 年的今天:hermes agent、OpenClaw、各种各样的 CLI、skills、MCP,你方唱罢我登场。潮起潮落,最后剩下些什么?服务端的 API 一定仍然是企业内最重要的“资产”。
在此背景下,我们该如何产出 API 文档?特别地限定一下讨论范围,我们如何在 企业内部 产出 API 文档供其他 技术人员 使用?
本文所说的“文档”不限于形式,Markdown、YAML、JSON,人和 agent 有一方能读就行。 后文的重点将会是 O pen A PI S pecification YAML/JSON 文档(legacy named as Swagger specification)。
抛出这个问题之后,可能会有以下质疑:
- “AI Native” 时代了,还有这种需求吗?
- 这难道不是很成熟的技术吗?
- 人工编写文档怎么了?
