agentsclimarketplace

Api reference documentation

Skill ulpi-io/plugin-marketplace/plugins/aj-geddes/skills/api-reference-documentation

A curated collection of 7,800+ agent skills for Claude Desktop, sourced from skills.sh

Install
npx -y skills add ulpi-io/plugin-marketplace --skill api-reference-documentation

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

2 things to look at

  • no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
  • 1 stars1 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.

What its author says it does

Copied from the file, not written here

Create comprehensive API reference documentation with OpenAPI/Swagger specs, REST endpoints, authentication, examples, and SDKs. Use when documenting REST APIs, GraphQL APIs, endpoint documentation, or OpenAPI specifications.

SKILL.md

2.8 KB, as published. Nobody here has run it

API Reference Documentation

Table of Contents

Overview

Generate professional API documentation that developers can use to integrate with your API, including endpoint specifications, authentication, request/response examples, and interactive documentation.

When to Use

  • Documenting REST APIs
  • Creating OpenAPI/Swagger specifications
  • GraphQL API documentation
  • SDK and client library docs
  • API authentication guides
  • Rate limiting documentation
  • Webhook documentation
  • API versioning guides

Quick Start

Minimal working example:

openapi: 3.0.3
info:
  title: E-Commerce API
  description: |
    Complete API for managing e-commerce operations including products,
    orders, customers, and payments.

    ## Authentication
    All endpoints require Bearer token authentication. Include your API key
    in the Authorization header: `Authorization: Bearer YOUR_API_KEY`

    ## Rate Limiting
    - 1000 requests per hour for authenticated users
    - 100 requests per hour for unauthenticated requests

    ## Pagination
    List endpoints return paginated results with `page` and `limit` parameters.
  version: 2.0.0
  contact:
    name: API Support
    email: [email protected]
    url: https://example.com/support
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
// ... (see reference guides for full implementation)

Reference Guides

Detailed implementations in the references/ directory:

GuideContents
OpenAPI Specification Exampleopenapi: 3.0.3
List ProductsList Products

Best Practices

✅ DO

  • Use OpenAPI 3.0+ specification
  • Include request/response examples for every endpoint
  • Document all query parameters and headers
  • Provide authentication examples
  • Include error response formats
  • Document rate limits and pagination
  • Use consistent naming conventions
  • Include SDK examples in multiple languages
  • Document webhook payloads
  • Provide interactive API explorer (Swagger UI)
  • Version your API documentation
  • Include migration guides for breaking changes

❌ DON'T

  • Skip error response documentation
  • Forget to document authentication
  • Use inconsistent terminology
  • Leave endpoints undocumented
  • Ignore deprecation notices
  • Skip versioning information

Keep looking

Skills are one crate of 328,083. 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.