Skip to content

feat: generate-spec command article - #337

Open
sobanieca-redocly wants to merge 16 commits into
mainfrom
feat/article-on-generate-spec
Open

feat: generate-spec command article#337
sobanieca-redocly wants to merge 16 commits into
mainfrom
feat/article-on-generate-spec

Conversation

@sobanieca-redocly

Copy link
Copy Markdown
Contributor

What/Why/How?

A new article for generate-spec command in Redocly CLI. To be published once drift article lands (#332) and when
generate-spec command is released (Redocly/redocly-cli#2937)

Reference

Testing

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@sobanieca-redocly
sobanieca-redocly marked this pull request as ready for review July 15, 2026 14:13

@redocly redocly Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 proxy command to capture traffic and consider safety implications regarding sensitive data.
  • Refine the generated descriptions with AI using the --with-ai flag and supported providers (Claude, Codex, Cursor).

Comment thread blog/generate-openapi-from-traffic.md
Comment thread blog/generate-openapi-from-traffic.md
Comment thread blog/generate-openapi-from-traffic.md Outdated
Comment thread blog/generate-openapi-from-traffic.md Outdated
Comment thread blog/generate-openapi-from-traffic.md Outdated
Comment thread blog/generate-openapi-from-traffic.md Outdated
Comment thread blog/generate-openapi-from-traffic.md Outdated
Comment thread blog/generate-openapi-from-traffic.md Outdated
Comment thread blog/generate-openapi-from-traffic.md
Flags, output, and behavior may change - including breaking changes - in upcoming releases while we shape it with your feedback.
{% /admonition %}

## Get started

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@sobanieca-redocly
sobanieca-redocly marked this pull request as draft August 5, 2026 10:58
Comment thread blog/generate-openapi-from-traffic.md Outdated
Comment thread blog/generate-openapi-from-traffic.md Outdated
Comment thread blog/generate-openapi-from-traffic.md Outdated
Comment thread blog/generate-openapi-from-traffic.md Outdated
Comment thread blog/generate-openapi-from-traffic.md Outdated
@sobanieca-redocly
sobanieca-redocly marked this pull request as ready for review August 31, 2026 08:53
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"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Date to be updated when merging

Comment thread blog/generate-openapi-from-traffic.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants