ApiFinder

Automatically discover and document Next.js API endpoints by analyzing your project's file structure. ApiFinder scans your Next.js project for API routes in both Pages Router and App Router patterns, extracts HTTP methods, and generates beautiful documentation.

CLI Usage

1# Analyze current directory and update README.md
2apifinder
3
4# Analyze specific project path
5apifinder --path /path/to/your/nextjs-project
6
7# Output to custom file
8apifinder --output API_DOCS.md
9
10# Preview without updating files
11apifinder --dry-run
12
13# Get JSON output
14apifinder --json

Programmatic Usage

1const { ApiFinder } = require('apifinder');
2
3async function analyzeProject() {
4  const analyzer = new ApiFinder('./my-nextjs-project');
5  const endpoints = await analyzer.analyze();
6  
7  console.log('Found endpoints:', endpoints);
8  
9  // Generate markdown table
10  const markdownTable = analyzer.generateMarkdownTable();
11  console.log(markdownTable);
12  
13  // Update README.md
14  await analyzer.updateReadme();
15}
16
17analyzeProject();

Supported Patterns

Pages Router

• pages/api/users.js → /api/users
• pages/api/users/[id].js → /api/users/:id
• pages/api/posts/[...slug].js → /api/posts/*slug
• src/pages/api/auth/login.js → /api/auth/login

App Router

• app/api/users/route.js → /api/users
• app/api/users/[id]/route.js → /api/users/:id
• app/api/posts/[...slug]/route.js → /api/posts/*slug
• src/app/api/auth/login/route.js → /api/auth/login

Output Example

ApiFinder generates a table like this in your README:

Route	Methods	File	Type
/api/auth/login	POST	pages/api/auth/login.js	Pages Router
/api/users	GET, POST	app/api/users/route.js	App Router
/api/users/:id	GET, PUT, DELETE	app/api/users/[id]/route.js	App Router
/api/posts/*slug	GET	pages/api/posts/[...slug].js	Pages Router

---

Configuration

CLI Options

Option	Description	Default
-p, --path <path>	Path to Next.js project	Current directory
-o, --output <file>	Output README file	README.md
--dry-run	Show endpoints without updating README	false
--json	Output endpoints as JSON	false