API Documenter
Генерация документации API
Разработчики тратят часы на ручное написание документации API. Этот навык автоматизирует создание комплексной документации API из кода или спецификаций OpenAPI, экономя время и обеспечивая согласованность.
Скачать ZIP навыка
Загрузить в Claude
Перейдите в Settings → Capabilities → Skills → Upload skill
Включите и начните использовать
Протестировать
Использование «API Documenter». Generate API docs for a GET /users/{id} endpoint that returns user profile data
Ожидаемый результат:
- # GET /users/{id}
- Retrieves a user profile by unique identifier.
- ## Request
- - Method: GET
- - Path: /users/{id}
- - Auth: Bearer token required
- ## Response 200
- ```json
- {"id": "user_123", "name": "John Doe", "email": "john@example.com"}
- ```
Использование «API Documenter». Document this OpenAPI spec for a pets API
Ожидаемый результат:
- # Pet Store API
- ## Overview
- RESTful API for managing pet inventory.
- ## Endpoints
- - GET /pets - List pets
- - POST /pets - Add pet
- - GET /pets/{id} - Get pet
- - DELETE /pets/{id} - Remove pet
Аудит безопасности
БезопасноThis is a prompt-only skill that generates API documentation. Static analysis found no executable code, no network requests, no filesystem access, and no external command execution. The skill contains only natural language prompts for generating documentation content.
Оценка качества
Что вы можете построить
Быстрая документация API для внутренних сервисов
Оперативная генерация документации для внутренних микросервисов во время спринтов разработки
Документация публичного API
Создание качественной пользовательской документации для публичных API-продуктов
Восстановление документации унаследованного API
Генерация документации для недокументированных унаследованных API путём анализа кода
Попробуйте эти промпты
Generate API documentation for the following endpoint: [paste endpoint code or description]
Create comprehensive API documentation for this OpenAPI specification: [paste OpenAPI JSON/YAML]
Generate API documentation with code examples in Python, JavaScript, and curl for: [paste endpoint details]
Create polished markdown API documentation with sections for overview, endpoints, authentication, error codes, and examples: [paste API specification]
Лучшие практики
- Предоставляйте полные спецификации OpenAPI для наилучших результатов
- Включайте детали аутентификации во входные данные
- Проверяйте сгенерированные примеры на точность перед публикацией
Избегать
- Ожидание живого тестирования эндпоинтов API
- Предоставление неполных или неоднозначных описаний эндпоинтов
- Предположение, что навык знает ваши конкретные внутренние соглашения