feat: generate-spec command article - #337
Conversation
There was a problem hiding this comment.
marketing-site AI Review: 🟢 Completed
Redocly Agent has reviewed your changes and found 3 potential issue(s).
Note
Low Risk
This PR only adds a new blog post and does not modify any source code or application logic, meaning there is no operational or system risk.
Overview
Adds a new article (blog/generate-openapi-from-traffic.md) detailing the upcoming generate-spec command for the Redocly CLI. The post explains how to:
- Deterministically generate baseline OpenAPI descriptions from recorded HTTP traffic (like HAR files).
- Use the
proxycommand to capture traffic and consider safety implications regarding sensitive data. - Refine the generated descriptions with AI using the
--with-aiflag and supported providers (Claude, Codex, Cursor).
| Flags, output, and behavior may change - including breaking changes - in upcoming releases while we shape it with your feedback. | ||
| {% /admonition %} | ||
|
|
||
| ## Get started |
There was a problem hiding this comment.
I think what we miss is some kind of comparison of --with-ai mode vs regular one or vs other open-source tools in this area.
There was a problem hiding this comment.
Added comparison with and without AI. Only for our case now, without comparison against other open source tools. I think comparison with other open source tools would be beneficial for separate article? Here we introduce a new tool in our stack. Otherwise the article will get quite long.
Also, I don't see that many OSS tools that do similar things. Need to dig further. One candidate I've found: https://apisyouwonthate.com/blog/turn-http-traffic-into-openapi-with-optic/ but it doesn't have --with-ai option.
Co-authored-by: Adam Altman <adam@redocly.com>
Co-authored-by: Adam Altman <adam@redocly.com>
Co-authored-by: Adam Altman <adam@redocly.com>
Co-authored-by: Adam Altman <adam@redocly.com>
Co-authored-by: Adam Altman <adam@redocly.com>
| title: Generate OpenAPI from real traffic (with AI) | ||
| description: The new generate-spec command infers an OpenAPI description from recorded HTTP traffic - with AI refinement. | ||
| author: adam-sobaniec | ||
| publishedDate: "2026-08-31" |
There was a problem hiding this comment.
Date to be updated when merging
What/Why/How?
A new article for
generate-speccommand in Redocly CLI. To be published oncedriftarticle lands (#332) and whengenerate-speccommand is released (Redocly/redocly-cli#2937)Reference
Testing
Screenshots (optional)
Check yourself
Security