repo-api-scan

Scan PHP/Laravel and Java/Spring Boot API endpoints into a Markdown feature list.

3|Updated Apr 2, 2026
One-click install
npx skills add https://github.com/weiran-tech/agent-skills --skill repo-api-scan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-api-scan
Source: https://github.com/weiran-tech/agent-skills/tree/main/skills/repo-api-scan
Command: npx skills add https://github.com/weiran-tech/agent-skills --skill repo-api-scan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scans a project's API endpoints, organizes them by module and domain, and outputs a consolidated feature-list outline in Markdown to help teams understand the system's interfaces quickly.

Core Features & Use Cases

  • Automatic API discovery: Detects endpoints from common PHP/Laravel and Java/Spring Boot structures.
  • Module/domain grouping: Groups features by logical modules or business domains for clear ownership.
  • Markdown output: Generates a ready-to-export doc like docs/feature-list.md to share with stakeholders.
  • Use Case: A developer opens a monorepo, runs the scan, and obtains a structured feature list mapping routes to modules to aid planning.

Quick Start

Scan your repository to detect PHP/Laravel or Java/Spring Boot APIs and output a Markdown feature-list at docs/feature-list.md.

Frequently Asked Questions about repo-api-scan

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I scan and document API endpoints in a Laravel or Spring Boot project?

To scan and document API endpoints, this Skill reads routes and controllers from PHP/Laravel or Java/Spring Boot projects, groups them by module and domain, and outputs a structured Markdown feature list at docs/feature-list.md.

What is the best way to generate a module-based feature list from existing API routes?

Generating a module-based feature list is done by automatically detecting API endpoints, grouping them by logical business domains or modules, and exporting a consolidated Markdown document for stakeholders.

Does this API scan tool work with both PHP and Java frameworks?

Yes, the API scan tool works with PHP/Laravel and Java/Spring Boot structures, automatically discovering endpoints from common project layouts and organizing them by module.

Can I automatically map controller routes to business domains for documentation?

You can automatically map controller routes to business domains by running a repository scan that reads existing endpoint declarations, groups paths by module, and generates a Markdown outline.

What output format does the API endpoint scan generate for stakeholders?

The API endpoint scan generates a ready-to-export Markdown document at docs/feature-list.md, providing a structured feature list that maps routes to modules for team planning.

Why should I use an automated API scanner instead of manually documenting endpoints?

An automated API scanner quickly parses large monorepos to detect endpoints and group features by domain, helping teams understand system interfaces faster than manual documentation efforts.