القائمة
Create comprehensive API documentation with examples, parameter descriptions, and interactive code samples
يُحدَّد Prompt الذي يراجع المصدر أولًا بشكل افتراضي. يمكنك التبديل إلى أمر مباشر أو تنزيل نسخة محلية.
اقرأ SKILL.md وأي ملفات مرافقة يعرضها SkillsMP قبل أن تقرر التثبيت.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
يتجاوز الأمر المباشر Prompt المخصّص للمراجعة. افحص المصدر قبل تشغيله.
npx skills add https://github.com/Wesley1600/ClaudeCodeFrameWork --skill api-documentationيبقى الأمر في سطر واحد. مرّر أفقيًا لمراجعته كاملًا قبل النسخ.
تفضّل نسخة محلية؟ نزّل الملفات المتاحة حاليًا لدى SkillsMP.
عرض SKILL.md
| name | api-documentation |
| description | Create comprehensive API documentation with examples, parameter descriptions, and interactive code samples |
Create professional API documentation that's clear, complete, and easy to use. This skill helps you generate well-structured API docs that serve both developers and non-technical stakeholders.
This skill assists in generating and organizing API documentation that includes:
Use this skill when you need to:
When using this skill:
Endpoint: Create User
POST /api/v1/users
Description: Creates a new user account with the provided information.
Authentication: Bearer Token (required)
Request:
{
"email": "user@example.com",
"name": "John Doe",
"role": "developer"
}
Response (201 Created):
{
"id": "usr_12345",
"email": "user@example.com",
"name": "John Doe",
"role": "developer",
"created_at": "2024-01-15T10:30:00Z"
}
Error Response (400 Bad Request):
{
"error": "INVALID_EMAIL",
"message": "The provided email is invalid",
"field": "email"
}
Input:
endpoints:
- path: /api/products
method: GET
description: List all products
parameters:
- name: limit
type: integer
required: false
default: 20
Output: OpenAPI 3.0 YAML specification with all endpoints, schemas, and examples properly formatted.
This skill includes templates for:
Helper scripts include:
| Pattern | Use Case | Complexity |
|---|---|---|
| REST | General purpose APIs | Low |
| GraphQL | Complex data queries | High |
| gRPC | High-performance services | High |
| WebSocket | Real-time communication | Medium |
| OpenAPI | Standardized specification | Medium |
For help with API documentation:
assets/templates/scripts/Maintains versions of skills, prompts, or documents. Provides version tagging, release management, changelogs, and rollback capabilities. Tracks changes to SKILL.md files, scripts, and resources using git-based version control with semantic versioning.
Maintains versions of skills, prompts, or documents. Provides version tagging, release management, changelogs, and rollback capabilities. Tracks changes to SKILL.md files, scripts, and resources using git-based version control with semantic versioning.
Retrieves and analyzes content from user-provided URLs or search results using the WebFetch tool. Manages domain filtering and max_uses limits to prevent data exfiltration. Use when users provide URLs to fetch, when analyzing web pages, or when following up on search results.
استنادا إلى تصنيف SOC المهني