agentsclimarketplace
Sign in

Generate api docs

Skill emaraschio/cursor-commands/.cursor/skill-contracts/generate-api-docs

Generate API documentation from codeFrom its SKILL.md

Install
npx -y skills add emaraschio/cursor-commands --skill generate-api-docs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 9 stars9 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

1.4 KB, 264 tokens by cl100k_base, as published. Nobody here has run it

Overview

Create comprehensive API documentation for the current endpoints formatted as OpenAPI/Swagger specification or following the project's documentation standards.

Steps

  1. API Overview
    • Service description and purpose
    • Base URL and versioning information
    • Authentication and authorization requirements
    • Rate limiting and usage policies
  2. Endpoint Documentation
    • HTTP method and URL path
    • Request parameters (path, query, body)
    • Request/response schemas with data types
    • Example requests and responses
    • Possible error codes and messages
  3. Data Models
    • Define all data models and schemas
    • Include field descriptions and constraints
    • Show relationships between models
    • Provide example payloads
  4. Usage Examples
    • Common use case scenarios
    • SDK and client library examples
    • CURL command examples
    • Error handling examples

API Documentation Checklist

  • API overview complete
  • Endpoints documented
  • Data models defined
  • Usage examples provided
  • Documentation formatted per project standards

Guardrails

  • Document only endpoints that exist in code; do not invent endpoints, parameters, or responses.
  • Use placeholder values in examples; never expose real secrets or credentials.

What ships with it: 3 files

2.6 KB alongside SKILL.md

eval/

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.