api-documentation

Generate and maintain Swagger/OpenAPI documentation for the Merge E-Commerce Backend.

Updated Dec 31, 2025

Search Tags:#documentation #API #OpenAPI #Swagger #controllers #DTO

Ready to run

npx skills add https://github.com/ademceper/merge --skill api-documentation-ademceper

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/ademceper/merge/tree/main/server/.claude/skills/api-documentation
Command: npx skills add https://github.com/ademceper/merge --skill api-documentation-ademceper

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the generation and upkeep of API documentation for the Merge E-Commerce backend, reducing manual drafting and ensuring the docs stay in sync with code changes.

Core Features & Use Cases

Auto-generates comprehensive API docs from controllers and DTOs
Synchronizes updates with code changes and new endpoints
Produces and maintains Swagger/OpenAPI references for client integration
Use Case: After adding a new endpoint, run the documentation generator to update the docs and publish to the internal docs portal

Quick Start

Run the documentation generator to scan the API and refresh the docs. The skill integrates with the project build and Swagger configuration.

Frequently Asked Questions about api-documentation

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

FAQPage Schema

How do I auto-generate API documentation from controllers and DTOs?▼

To auto-generate API documentation, run the documentation generator to scan your controllers and DTOs and refresh the docs. The skill integrates with the project build and Swagger configuration to produce accessible API references.

How do I keep Swagger or OpenAPI references in sync with code changes?▼

To keep Swagger or OpenAPI references in sync, run the documentation generator after adding a new endpoint or evolving DTOs. It automatically updates the docs to match the latest codebase changes and publishes them to the internal docs portal.

What do I need for XML comments and DTO annotations to produce accessible API docs?▼

You need XML comments on controllers and DTO annotations integrated with the build pipeline to produce accessible API docs. The skill satisfies these requirements to generate comprehensive Swagger/OpenAPI references for client integration.

Can I use this for maintaining API documentation across a large e-commerce backend codebase?▼

Yes, you can use this for maintaining API documentation across a large e-commerce backend codebase. It automates the generation and upkeep of docs, reducing manual drafting and ensuring they stay synchronized with new endpoints and evolving DTOs.

What's the best way to document new endpoints without manual drafting?▼

The best way to document new endpoints without manual drafting is running the documentation generator. It scans the API, refreshes the Swagger/OpenAPI references, and publishes the updated comprehensive docs to your internal portal.

When should I not rely on automated API documentation generation for my project?▼

You should not rely on automated API documentation generation when your controllers lack XML comments or DTOs lack annotations. The skill requires these inputs, along with build pipeline integration, to synchronize updates and produce valid OpenAPI references.