一人工程 · solus opus

← 全部作品

一人工程api-docssoloopenapi

solo engineer 没有 API documentation,我自己 commit 就是 doc

团队有 API documentation。

API documentation:API 文档。OpenAPI / Swagger:API spec。Postman:API 测试工具。API blueprint:API design language。Developer portal:开发者门户。ReadMe.io / Mintlify:文档工具。$100-$500 / 月 each。

每个 startup 1 个 developer portal + 1 个 API doc writer。$100K-$300K / 年。

solo engineer 没有 API documentation。

我自己 commit 就是 doc。

我 commit message = doc description。TypeScript type = API spec。git log = API blueprint。我不需要 Swagger、不需要 OpenAPI、不需要 Postman、不需要 developer portal。

我没 API documentation 的必要——访问量 1000,没 enterprise customer 要 integration。我没 OpenAPI 的必要——没 3rd party 要 integrate。我没 Swagger 的必要——没 API spec 要写。我没 Postman 的必要——没 API 测试。我没 API blueprint 的必要——没 blueprint 要 design。我没 developer portal 的必要——没 developer 要 onboard。我没 ReadMe.io 的必要——commit log = readme。我没 Mintlify 的必要——散文 = docs。我没 $100-$500 / 月 的必要——Vercel free。

团队的 API documentation 价值是「让 3rd party developer 接入」。前提是有 3rd party developer、需要 integration、需要 onboarding。solo engineer 没这个问题——没 3rd party、不需要 integration、commit log = onboarding。

一人工程的 API documentation = commit log + TypeScript type。不是 Swagger $300/月。