crowgent-openapi 1.0.0

package/README.md

@@ -0,0 +1,63 @@
+# crowgent-openapi
+
+Generate OpenAPI specs from your backend code using AI.
+
+## Installation
+
+```bash
+npm install -g crowgent-openapi
+```
+
+Or use directly with npx:
+
+```bash
+npx crowgent-openapi ./src/routes -o openapi.yaml
+```
+
+## Usage
+
+```bash
+# Set your OpenAI API key
+export OPENAI_API_KEY=sk-...
+
+# Generate spec from your backend
+crowgent-openapi ./backend/routes -o openapi.yaml
+
+# Specify base URL
+crowgent-openapi ./src -o api.yaml --base-url https://api.example.com
+
+# Use a different model
+crowgent-openapi ./src -o api.yaml --model gpt-4o
+```
+
+## Options
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-o, --output <file>` | Output file path | `openapi.yaml` |
+| `-k, --api-key <key>` | OpenAI API key | `$OPENAI_API_KEY` |
+| `-m, --model <model>` | Model to use | `gpt-4o-mini` |
+| `--base-url <url>` | API base URL | `http://localhost:3000` |
+
+## Supported Frameworks
+
+Works with any backend - the AI understands:
+- Express.js / Node.js
+- Next.js API routes
+- FastAPI / Flask / Django
+- Go / Gin / Chi
+- Ruby on Rails
+- And more...
+
+## How It Works
+
+1. Scans your source files (`.ts`, `.js`, `.py`, etc.)
+2. Sends code to GPT-4o-mini for analysis
+3. Returns a complete OpenAPI 3.0 spec
+
+Typical cost: **~$0.002 per scan** (less than a penny).
+
+## License
+
+MIT
+

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,75 @@
+#!/usr/bin/env node
+import { program } from 'commander';
+import { readFileSync, writeFileSync, readdirSync, statSync } from 'fs';
+import { join, extname, relative } from 'path';
+import OpenAI from 'openai';
+const EXTENSIONS = ['.ts', '.js', '.tsx', '.jsx', '.py', '.rb', '.go', '.java', '.kt', '.rs'];
+const IGNORE = ['node_modules', '.git', 'dist', 'build', '__pycache__', '.next', 'coverage'];
+program
+    .name('crowgent-openapi')
+    .description('Generate OpenAPI specs from your backend code using AI')
+    .argument('<directory>', 'Backend directory to scan')
+    .option('-o, --output <file>', 'Output file', 'openapi.yaml')
+    .option('-k, --api-key <key>', 'OpenAI API key (or set OPENAI_API_KEY)')
+    .option('-m, --model <model>', 'Model to use', 'gpt-4o-mini')
+    .option('--base-url <url>', 'API base URL', 'http://localhost:3000')
+    .action(async (directory, opts) => {
+    const apiKey = opts.apiKey || process.env.OPENAI_API_KEY;
+    if (!apiKey) {
+        console.error('❌ Missing API key. Set OPENAI_API_KEY or use --api-key');
+        process.exit(1);
+    }
+    console.log('📂 Scanning files...');
+    const files = collectFiles(directory);
+    console.log(`   Found ${files.length} source files`);
+    if (files.length === 0) {
+        console.error('❌ No source files found');
+        process.exit(1);
+    }
+    console.log('🤖 Generating OpenAPI spec...');
+    const openai = new OpenAI({ apiKey });
+    const codeContext = files
+        .map(f => `### ${f.path}\n\`\`\`\n${f.content}\n\`\`\``)
+        .join('\n\n');
+    const response = await openai.chat.completions.create({
+        model: opts.model,
+        messages: [{
+                role: 'system',
+                content: `You are an expert at generating OpenAPI 3.0 specifications. 
+Analyze the provided backend code and generate a complete, valid OpenAPI 3.0.3 YAML spec.
+Include: all endpoints, HTTP methods, path/query parameters, request bodies, response schemas with properties.
+Use descriptive summaries. Infer types from the code. Return ONLY valid YAML, no markdown or explanation.`
+            }, {
+                role: 'user',
+                content: `Generate an OpenAPI spec for this backend code. Base URL: ${opts.baseUrl}\n\n${codeContext}`
+            }],
+        max_tokens: 16000,
+        temperature: 0.2,
+    });
+    let yaml = response.choices[0].message.content || '';
+    // Strip markdown fences if present
+    yaml = yaml.replace(/^```ya?ml\n?/i, '').replace(/\n?```$/i, '').trim();
+    writeFileSync(opts.output, yaml);
+    console.log(`✅ Saved to ${opts.output}`);
+    console.log(`   ${response.usage?.total_tokens || '?'} tokens used`);
+});
+function collectFiles(dir, root = dir) {
+    const files = [];
+    for (const entry of readdirSync(dir)) {
+        if (entry.startsWith('.') || IGNORE.includes(entry))
+            continue;
+        const fullPath = join(dir, entry);
+        const stat = statSync(fullPath);
+        if (stat.isDirectory()) {
+            files.push(...collectFiles(fullPath, root));
+        }
+        else if (EXTENSIONS.includes(extname(entry)) && stat.size < 100_000) {
+            files.push({
+                path: relative(root, fullPath),
+                content: readFileSync(fullPath, 'utf-8'),
+            });
+        }
+    }
+    return files;
+}
+program.parse();

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "crowgent-openapi",
+  "version": "1.0.0",
+  "description": "Generate OpenAPI specs from your backend code using AI",
+  "type": "module",
+  "bin": {
+    "crowgent-openapi": "./dist/cli.js"
+  },
+  "main": "./dist/cli.js",
+  "scripts": {
+    "build": "tsc && chmod +x dist/cli.js",
+    "dev": "tsx src/cli.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "files": ["dist", "README.md"],
+  "dependencies": {
+    "commander": "^12.0.0",
+    "openai": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsx": "^4.0.0",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": ["openapi", "swagger", "api", "generator", "ai", "llm", "gpt", "documentation"],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/usecrow/crowgent-openapi"
+  },
+  "author": "Crow",
+  "license": "MIT"
+}
+