api-reference-documentation

仓库创建 2025年11月8日最近提交 29 天前SkillHot 收录 22 天前

▸ 精选理由

便于对内对外提供规范化文档与自动化 SDK、测试入口。

这个 Skill 做什么

使用 OpenAPI 规范生成交互式 API 参考文档与示例。

用 OpenAPI 把 REST 接口变成可交互的参考文档，自动生成端点说明、示例和“Try it out”的在线调试。适合对外或给开发者队列提供 SDK、说明或开发门户时使用。优点是标准化、能自动生成示例代码和客户端库，降低集成门槛。

▸ 展开 SKILL.md 英文原文

Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples. Use when documenting REST APIs, creating SDK references, or building developer portals.

开发编程文档OpenAPI开发者门户通用

180

Stars

Forks

仓库内 Skill

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/secondsky/claude-skills/main/plugins/api-reference-documentation/skills/api-reference-documentation/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/secondsky/claude-skills/main/plugins/api-reference-documentation/skills/api-reference-documentation/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# API Reference Documentation

Create comprehensive API documentation for developer integration.

## OpenAPI 3.0 Specification

```yaml
openapi: 3.0.3
info:
  title: E-Commerce API
  version: 1.0.0
  description: API for managing products and orders
  contact:
    email: api@example.com

servers:
  - url: https://api.example.com/v1
    description: Production
  - url: https://staging-api.example.com/v1
    description: Staging

security:
  - bearerAuth: []

paths:
  /products:
    get:
      summary: List products
      tags: [Products]
      parameters:
        - name: limit
          in: query
          schema: { type: integer, default: 20 }
        - name: category
          in: query

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有