Initial commit

This commit is contained in:
Zhongwei Li
2025-11-29 18:06:03 +08:00
commit d7b51d17cc
4 changed files with 82 additions and 0 deletions

View File

@@ -0,0 +1,12 @@
{
"name": "generate-api-docs",
"description": "Generate API documentation for endpoints",
"version": "1.0.0",
"author": {
"name": " Anand Tyagi",
"url": "https://github.com/ananddtyagi"
},
"commands": [
"./commands"
]
}

3
README.md Normal file
View File

@@ -0,0 +1,3 @@
# generate-api-docs
Generate API documentation for endpoints

View File

@@ -0,0 +1,22 @@
---
allowed-tools: Bash(find:*)
description: Generate API documentation for endpoints
---
## Context
- API routes: !`find . -path "*/routes/*" -name "*.js" -o -path "*/api/*" -name "*.js" | head -20`
- Current API files: @$ARGUMENTS
## Your task
Generate comprehensive API documentation including:
1. **Endpoint Overview**: Method, URL, purpose
2. **Parameters**: Query params, path params, request body
3. **Request Examples**: Sample requests with curl
4. **Response Examples**: Success and error responses
5. **Status Codes**: All possible HTTP status codes
6. **Authentication**: Required auth if applicable
Format as clear, readable documentation that can be used by other developers.

45
plugin.lock.json Normal file
View File

@@ -0,0 +1,45 @@
{
"$schema": "internal://schemas/plugin.lock.v1.json",
"pluginId": "gh:ccplugins/awesome-claude-code-plugins:plugins/generate-api-docs",
"normalized": {
"repo": null,
"ref": "refs/tags/v20251128.0",
"commit": "9be4953d05db0ead9fb2ef7ecf6dea6c297c7acd",
"treeHash": "4e9b9615c6ec7c8ec1d5d027dec71aef0b3072c3d1f71207c124d4d8171fa6d0",
"generatedAt": "2025-11-28T10:14:34.524425Z",
"toolVersion": "publish_plugins.py@0.2.0"
},
"origin": {
"remote": "git@github.com:zhongweili/42plugin-data.git",
"branch": "master",
"commit": "aa1497ed0949fd50e99e70d6324a29c5b34f9390",
"repoRoot": "/Users/zhongweili/projects/openmind/42plugin-data"
},
"manifest": {
"name": "generate-api-docs",
"description": "Generate API documentation for endpoints",
"version": "1.0.0"
},
"content": {
"files": [
{
"path": "README.md",
"sha256": "be11bb4e9959907fb802bedad06afa87d7b681384dc132b1997f5b74295a6319"
},
{
"path": ".claude-plugin/plugin.json",
"sha256": "2e38b05089b6db3778ece55f7ff3851a38bd276e660d30a6cf8fd55276b2ee3c"
},
{
"path": "commands/generate-api-docs.md",
"sha256": "0a5c5ab6872c54d0d4d05e78d6dc0163ccbe41d1c608250819fff03ff87b85b4"
}
],
"dirSha256": "4e9b9615c6ec7c8ec1d5d027dec71aef0b3072c3d1f71207c124d4d8171fa6d0"
},
"security": {
"scannedAt": null,
"scannerVersion": null,
"flags": []
}
}