apify

Generate API documentation from backend route definitions and type information.

Updated Mar 17, 2023

Search Tags:#documentation #api #openapi #code generation #backend #swagger

Ready to run

npx skills add https://github.com/gsarmaonline/nvim --skill apify-gsarmaonline

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: apify
Source: https://github.com/gsarmaonline/nvim/tree/main/claude/skills/apify
Command: npx skills add https://github.com/gsarmaonline/nvim --skill apify-gsarmaonline

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the creation and maintenance of comprehensive API documentation, ensuring it stays synchronized with your codebase and reducing manual effort.

Core Features & Use Cases

Automated Discovery: Detects backend frameworks and languages to understand your API structure.
Comprehensive Documentation: Generates Markdown, OpenAPI/Swagger specs, Postman collections, and cURL examples.
Use Case: After deploying a new version of your backend API with updated routes and request/response types, run this Skill to automatically update all associated documentation artifacts and integrate the changes into your CI/CD pipeline.

Quick Start

Use the apify skill to generate API documentation for the current project.

Frequently Asked Questions about apify

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

FAQPage Schema

How do I auto-generate API documentation from backend route definitions?▼

To auto-generate API documentation, the Skill extracts routes, methods, parameters, and request/response types directly from your backend codebase. It detects frameworks like Node.js, Python, Go, and Rust to produce Markdown, OpenAPI, and Postman collections automatically.

What is the best way to keep OpenAPI and Swagger specs in sync with code changes?▼

Keeping OpenAPI and Swagger specs in sync with code changes is achieved by integrating this generation process into your CI/CD workflow. This ensures that every deployment updates your documentation artifacts automatically based on the latest route definitions.

Does this API documentation generator support FastAPI and Flask Python frameworks?▼

Yes, this API documentation generator supports Python frameworks including FastAPI and Flask. It also works with Node.js frameworks like Express, Fastify, and NestJS, alongside Go and Rust backend applications.

Can I generate Postman collections and cURL examples from existing backend code?▼

You can generate Postman collections and cURL examples from existing backend code by running this Skill. It parses your application's route definitions and type information to output these formats alongside standard OpenAPI and Markdown documentation.

How do I extract API status codes and response types for multiple frameworks?▼

Extracting API status codes and response types for multiple frameworks is handled automatically through framework detection. The Skill analyzes your backend application's type information across Node.js, Python, Go, and Rust to compile comprehensive documentation.