Skip to content

Commit f7a39d3

Browse files
committed
docs: add value proposition to Other Frameworks section explaining unified generation benefits
Signed-off-by: spencercjh <spencercjh@gmail.com>
1 parent 287337b commit f7a39d3

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,11 @@ OpenAPI docs. Spec Forge wraps `protoc-gen-connect-openapi` — a maintained, Op
142142
**Hertz / Kitex (CloudWeGo)** — Official OpenAPI docs are outdated. Spec Forge will wrap the working tools from
143143
`hertz-contrib/swagger-generate` into a single command (coming soon).
144144

145+
**Why use Spec Forge when frameworks have their own tools?** Each framework's ecosystem requires different setup,
146+
dependencies, and CI configurations. Spec Forge reduces integration cost by providing a unified generation interface — one
147+
command, one config file, consistent output across all your services. This enables centralized CI/CD pipelines that
148+
generate, validate, enrich, and publish API documentation automatically, regardless of which framework each team chose.
149+
145150
---
146151

147152
## How It Works

README.zh_CN.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,8 @@ LLM **从不** 虚构类型或改变结构 —— 它只为我们已经验证存
117117

118118
**Hertz / Kitex (CloudWeGo)** —— 官方 OpenAPI 文档已过时。Spec Forge 将把 `hertz-contrib/swagger-generate` 中的可用工具封装成一条命令(即将推出)。
119119

120+
**为什么框架已有文档工具还需要 Spec Forge?** 每个框架的生态需要不同的设置、依赖和 CI 配置。Spec Forge 通过提供统一的生成界面来降低接入成本 —— 一条命令、一个配置文件,跨所有服务输出一致的规范。这使得集中式 CI/CD 流水线能够自动生成、验证、增强和发布 API 文档,无论各团队选择了哪种框架。
121+
120122
---
121123

122124
## 工作原理

0 commit comments

Comments
 (0)