api-endpoints

Analyze project endpoints and classify them into Query and Command operations.

Updated Aug 27, 2026

Search Tags:#automation #testing #documentation #api #classification #endpoints #analyze

Ready to run

npx skills add https://github.com/ryu-qqq/conventionHub --skill api-endpoints-ryu-qqq

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-endpoints
Source: https://github.com/ryu-qqq/conventionHub/tree/main/.claude/skills/api-endpoints
Command: npx skills add https://github.com/ryu-qqq/conventionHub --skill api-endpoints-ryu-qqq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill analyzes a project's API surface and categorizes endpoints into read (Query) and write (Command) to standardize documentation and testing pipelines.

Core Features & Use Cases

Endpoint classification: automatically detects HTTP methods and path patterns to distinguish Query vs Command.
Documentation generation: produces a structured markdown doc at claudedocs/api-endpoints/{admin|web}/{module}_endpoints.md.
Use Case: when integrating a new module, quickly produce consistent endpoint docs for QA and CI.

Quick Start

Run the admin/api-endpoints analyzer to categorize and document endpoints for the selected module.

Frequently Asked Questions about api-endpoints

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

FAQPage Schema

How do I classify API endpoints into Query and Command for documentation?▼

Classifying API endpoints into Query and Command involves analyzing HTTP methods and path patterns to distinguish read operations from write operations. This Skill extracts endpoint definitions from controllers and generates standardized markdown documentation categorizing them accordingly.

How do I generate standardized endpoint documentation for integration tests and pipelines?▼

Generating standardized endpoint documentation for integration tests requires analyzing your project's API surface and outputting a structured markdown file. This Skill produces documents at claudedocs/api-endpoints/{admin|web}/{module}_endpoints.md for QA and CI usage.

What is the difference between Query and Command API endpoints?▼

Query API endpoints represent read operations that retrieve data, while Command endpoints represent write operations that modify state. This distinction standardizes API surface documentation by inferring the operation type from HTTP methods and path patterns.

Can I automatically extract endpoint definitions from controllers for admin and web modules?▼

Extracting endpoint definitions from controllers for admin and web modules is fully supported. The analyzer automatically detects endpoints, infers operation types, and outputs separate markdown documents structured by module for consistent documentation.

Does this API endpoint analyzer require any external dependencies to run?▼

No external dependencies are required to run this API endpoint analyzer. It operates independently to analyze project endpoints, classify them into Query and Command, and generate the markdown documentation output.