oas-generator

OAS Generator

Generates an OpenAPI 3.x YAML spec by statically analysing a provider codebase with ripwire. The spec may be incomplete (stubs for unresolvable schemas), but it will always be valid OAS and immediately usable for path-coverage testing.

Prerequisites: ripwire on PATH. If absent, check pact-coverage/references/install-ripwire.md.

---

Step 1 — Identify the framework

Run ripwire to get oriented, then infer the framework from the ranked output and config files:

ripwire <provider-root> --for="HTTP route definitions and request handlers"

Also check for framework config files in the project root:

• Gemfile with sinatra or rails → Ruby
• package.json with express, fastify, koa, or hapi → Node.js
• pyproject.toml / requirements.txt with flask or fastapi → Python

If the framework is still ambiguous after these checks, ask the user.

---

Step 2 — Extract all routes

Use framework-specific patterns to find every route registration. Run all applicable patterns and deduplicate results. Use --regex= for these patterns: --grep= is a literal match, so alternation (a|b) silently returns zero hits.

Ruby — Rails

ripwire <root> --regex="resources|get '|post '|put '|patch '|delete '|namespace"

Also expand config/routes.rb to get the full route DSL, then trace each action to its controller method to find what each path actually maps to.

Ruby — Sinatra

ripwire <root> --regex="get '|post '|put '|patch '|delete '"

Each match is a route; the enclosing block is the handler. Note the in= attribute from grep hits to get the enclosing symbol name, then --expand it for the full handler body.

Node.js — Express / Fastify / Koa

ripwire <root> --regex='\.get\(|\.post\(|\.put\(|\.patch\(|\.delete\(|\.route\('

Also check for router objects (e.g. router.get() and app.use( with sub-routers.

Python — Flask

ripwire <root> --regex='@app\.route|@blueprint\.|@bp\.'