惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

Vercel News
Vercel News
奇客Solidot–传递最新科技情报
奇客Solidot–传递最新科技情报
Apple Machine Learning Research
Apple Machine Learning Research
T
Tailwind CSS Blog
让小产品的独立变现更简单 - ezindie.com
让小产品的独立变现更简单 - ezindie.com
人人都是产品经理
人人都是产品经理
V
V2EX
量子位
Last Week in AI
Last Week in AI
Jina AI
Jina AI
博客园 - 【当耐特】
爱范儿
爱范儿
宝玉的分享
宝玉的分享
OSCHINA 社区最新新闻
OSCHINA 社区最新新闻
Hugging Face - Blog
Hugging Face - Blog
博客园 - 三生石上(FineUI控件)
有赞技术团队
有赞技术团队
小众软件
小众软件
IT之家
IT之家
博客园_首页
博客园 - 聂微东
S
SegmentFault 最新的问题
阮一峰的网络日志
阮一峰的网络日志
博客园 - 叶小钗

DEV Community

Authentication Security Deep Dive: From Brute Force to Salted Hashing (With Java Examples) Why AI Systems Don’t Fail — They Drift Spilling beans for how i learn for exam😁"Reinforcement Learning Cheat Sheet" I Replaced Chrome with Safari for AI Browser Automation. Here's What Broke (and What Finally Worked) How Python Borrows Other People's Work The $40 Architecture: Processing 1 Billion API Requests with 99.99% Uptime Vibe Coding: A Workflow Guide (From Zero to SaaS) Most webhook security guides protect the wrong side. The scary part is delivery. Headless CMS for TanStack Start: Build a Blog with Cosmic EU Age Verification App "Hacked in 2 Minutes" — What Actually Happened Comfy Cloud’s delete function does not actually remove files Running AI Models on GPU Cloud Servers: A Beginner Guide Event-driven media intelligence with AWS Step Functions and Bedrock I scored 500 AI prompts across 8 quality dimensions — here's what broke How to Call Google Gemini API from Next.js (Free Tier, No Backend Needed) The Portal Protocol: Reclaiming Human Connection in the Age of AI How to Fix Your Team's Scattered Knowledge Problem With a Self-Hosted Forum Intro to tc Cloud Functors: A Graph-First Mental Model for the Modern Cloud Designing Multi-Tenant Backends With Both Ownership and Team Access I Built a Neumorphic CSS Library with 77+ Components — Here's What I Learned PostgreSQL Performance Optimization: Why Connection Pooling Is Critical at Scale Cómo construí un SaaS multi-rubro para gestionar expensas en Argentina con FastAPI + Vue 3 🚀 I Built an Ethical Hacking Scanner Tool – Open Source Project I Replaced /usage and /context in Claude Code With a Single Statusline A Pythonic Way to Handle Emails (IMAP/SMTP) with Auto-Discovery and AI-Ready Design I Collected 8.9 Million Polymarket Price Points — Here's What I Found About How Markets Really Move EcoTrack AI — Carbon Footprint Tracker & Dashboard Everyone's Using AI. No One Agrees How. 5 self-hosted ebook managers worth trying in 2026 Building Your First AI Agent with LangChain: From Chatbot to Autonomous Assistant
I stopped manually maintaining OpenAPI specs — here's wha...
DocSmithDocS · 2026-05-07 · via DEV Community

DocSmithDocSmith

It was a Monday morning. A partner pinged us because their integration had broken overnight. Turns out, someone had merged a PR that renamed a response field from user_id to userId — camelCase instead of snake_case, a two-character diff — and the OpenAPI spec had not been updated. The spec said one thing. The API did another. The partner built against the spec.

That's spec drift. And if you've maintained a non-trivial API, you've been bitten by it.

The standard advice is "keep your docs close to your code." Put the OpenAPI YAML in the same repo. Add a linter to CI. Write a custom rule that fails the build if the spec is missing a path. This helps. It doesn't fix the underlying problem, which is that you're maintaining two sources of truth — the code and the spec — and hoping they stay in sync.

The real fix is to have only one source of truth.

The idea isn't new. For years, certain frameworks have offered a path here. If you're on NestJS, you can use @nestia or the built-in Swagger plugin and get spec generation from TypeScript types and decorators. If you're using FastAPI, you get it for free — the spec is generated from your Pydantic models and route definitions at runtime. If you're on tsoa, you write TypeScript classes with decorators and the spec is a build artifact.

The pattern is the same in all of them: the spec becomes a consequence of the code, not a parallel document you maintain by hand. When you rename a field in code, the spec updates automatically on next build. Drift becomes structurally impossible.

The problem is that this only works if you're already on one of those frameworks. If you have an Express app written without decorators, a Go service using chi or gin, a Fastapi app where someone skipped the Pydantic models for "simplicity," you're back to hand-maintenance.

What actually needs to happen for those cases is static analysis of the routes: parse the AST, find the route definitions, infer the request and response shapes from the types that flow through them, extract any JSDoc that's already there, and produce a spec that reflects what the code actually does.

This is what I've been building. It's called DocSmith. You point it at a repo, it scans the route definitions, and it produces an OpenAPI spec from the code — no decorators required, no framework lock-in. It currently understands Express (TypeScript and plain JS) and FastAPI, with more frameworks on the roadmap.

It's at demo and waitlist stage right now, not generally available. I want to be upfront about that — there's a live demo at docsmith-app.launchyard.app where you can see what the output looks like, and a waitlist if it seems useful to you. I'm not going to oversell where it is.

What I'm trying to figure out right now: what framework are you maintaining API docs for, and what's your current approach? Manual YAML? Postman collections? A decorator-based framework that handles it automatically? Something I haven't thought of?

Genuinely curious what's actually working for people — drop it in the comments.