Навыки api-doc-generator

📦

api-doc-generator

Name: api-doc-generator
Author: Hermes-Sedimentary

v1.0.0 Ревизия содержимого r1 Безопасно

Создать документацию API

Ручная документация API отстает от кода и создает путаницу для разработчиков. Этот навык помогает создавать черновики OpenAPI, примеры запросов и рекомендации по коллекциям Postman на основе доступного кода или сведений об эндпоинтах.

Поддерживает: Claude Codex Code(CC)

🥈 80 Серебро

Установить с помощью моего Агента

Скопируйте этот запрос в своего Агента. Он содержит каноническую страницу Skill и манифест.

Запрос агента

Review the Skillstore skill "api-doc-generator" from https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator.md and its manifest at https://skillstore.io/api/skills/zhangchenlai-dev-api-doc-generator/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Ваш Агент по-прежнему должен показать план и запросить все подтверждения, требуемые политикой безопасности.

Ресурсы для AI-агентов

Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.

Markdown-детали GET /skills/zhangchenlai-dev-api-doc-generator.md Подписанный manifest GET /api/skills/zhangchenlai-dev-api-doc-generator/manifest Подписанный lockfile GET /api/skills/zhangchenlai-dev-api-doc-generator/lockfile

Протестировать

Использование «api-doc-generator». В пользовательском сервисе есть эндпоинты create user, get user, update user и delete user.

Ожидаемый результат:

Структурированный справочник API с краткими описаниями эндпоинтов, полями запросов, примерами ответов, кодами состояния и разделами, готовыми для OpenAPI.

Использование «api-doc-generator». У команды есть код маршрутов, но нет документации по интеграции для партнеров.

Ожидаемый результат:

Понятный черновик интеграционной документации, который объясняет предположения об аутентификации, примеры запросов, ожидаемые ответы и организацию коллекции Postman.

Использование «api-doc-generator». В существующей спецификации API могут отсутствовать недавно добавленные маршруты.

Ожидаемый результат:

Обзор покрытия со списком отсутствующих эндпоинтов, неполных схем, неясных примеров и рекомендуемых обновлений документации.

Аудит безопасности

Безопасно

v5 • 08.07.2026 Открыть версионный отчет

The only static finding was a high-entropy heuristic on SKILL.md. Manual review found plain Markdown skill metadata and usage notes, with no obfuscation, prompt injection, exfiltration intent, or dangerous actions.

Просканировано файлов

Проанализировано строк

Пункты проверки

Ложные срабатывания проигнорированы

Последний завершенный статический и семантический аудит не обнаружил подтвержденных проблем безопасности. Это не доказывает отсутствие побочных эффектов у навыка.

Аудитор:: codex Посмотреть историю аудитов →

Поделиться и цитировать этот отчет

Делитесь версионным отчетом об оценке, нейтральным значком, встраиваемой карточкой и цитатами. Skillstore публикует доказательства, не решая, безопасен ли этот Skill.

Открыть версионный отчет

Копировать ссылку на отчёт

https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Значок Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/zhangchenlai-dev-api-doc-generator/security.svg)](https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator?utm_source=security_passport_badge)

Значок HTML

<a href="https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/zhangchenlai-dev-api-doc-generator/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Встраиваемая карточка

<iframe src="https://skillstore.io/embed/skills/zhangchenlai-dev-api-doc-generator.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

Академические ссылки (APA · BibTeX · CFF)

Цитата APA

Hermes-Sedimentary. (2026). api-doc-generator security audit report (audit version 5) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5

Цитата BibTeX

@techreport{hermes-sedimentary-zhangchenlai-dev-api-doc-generator-2026,
  author = {Hermes-Sedimentary},
  title = {api-doc-generator security audit report (audit version 5)},
  institution = {Skillstore},
  year = {2026},
  number = {5},
  url = {https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5},
  note = {Author version 1.0.0}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-doc-generator security audit report (audit version 5)"
version: "1.0.0"
type: report
authors:
  - name: "Hermes-Sedimentary"
date-released: "2026-07-08"
url: "https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5"
identifiers:
  - type: other
    value: "skillstore:zhangchenlai-dev-api-doc-generator:audit:5"
    description: "Skillstore immutable audit report identifier"

Оценка Skillstore

Почему такая оценка Достоверность доказательств: Средний

Архитектура

100

Сопровождаемость

Контент

Сообщество

Соответствие спецификации

Что вы можете построить

Задокументировать новый сервис

Создать первый черновик справочного контента API на основе обработчиков маршрутов и заметок по схемам.

Подготовить руководства по интеграции

Преобразовать сведения об эндпоинтах в понятные примеры запросов для внешних партнеров.

Стандартизировать спецификации API команды

Преобразовать разрозненные заметки об эндпоинтах в согласованную структуру, ориентированную на OpenAPI.

Попробуйте эти промпты

Создать базовую документацию эндпоинтов

Создай документацию API для этих эндпоинтов. Включи метод, путь, назначение, параметры, примеры запросов и примеры ответов.

Построить план OpenAPI

Просмотри этот код API и создай план OpenAPI 3.0 с путями, методами, телами запросов, схемами ответов и типовыми ошибками.

Подготовить рекомендации для Postman

Преобразуй эту документацию эндпоинтов в рекомендации по коллекции Postman. Включи папки, имена запросов, заголовки, переменные и примеры тел.

Проверить покрытие документации

Сравни эти маршруты с текущей документацией API. Определи отсутствующие эндпоинты, неясные схемы, несогласованные примеры и устаревшие описания ответов.

Лучшие практики

Предоставляйте код маршрутов, определения схем и сведения об аутентификации вместе.
Запрашивайте примеры, которые соответствуют реальной структуре запросов и ответов.
Проверяйте сгенерированный контент OpenAPI перед тем, как делиться им с клиентами.

Избегать

Не публикуйте сгенерированные спецификации без проверки их соответствия реализации.
Не опускайте контекст аутентификации, обработки ошибок или лимитов запросов.
Не воспринимайте примеры с placeholder как детали production-контракта.

Часто задаваемые вопросы

Может ли этот навык создать документ OpenAPI 3.0?

Да. Он может создавать разделы в стиле OpenAPI на основе кода или описаний эндпоинтов, но разработчик должен проверить результат.

Может ли он напрямую создавать коллекции Postman?

Он может подготовить рекомендации по коллекции Postman и организации запросов. Вывод, готовый к импорту, может потребовать ручного форматирования.

Проверяет ли он live API?

Нет. Навык описывает работу с документацией и сам по себе не тестирует live endpoints.

Какие входные данные подходят лучше всего?

Лучше всего подходят обработчики маршрутов, списки методов и путей, определения схем, примеры payload и заметки об аутентификации.

Полезен ли он для неанглоязычных команд?

Да. Исходное описание на китайском, а пользователи могут запрашивать документацию на предпочитаемом языке.

Является ли сгенерированная документация финальной?

Нет. Сгенерированную документацию следует проверить на точность, детали безопасности и поведение, зависящее от версии.

Сведения для разработчиков

Автор

Hermes-Sedimentary

Лицензия

MIT

Версия автора

v1.0.0

Ревизия Skillstore

Репозиторий

https://github.com/zhangchenlai-dev/hermes-skill-store/tree/master/api-doc-generator

Ссылка

64ca8af0f54a325752f08bd54e52151061ea659a

Актуальность поддержки

20.07.2026

Использование

2 загрузок · 1 просмотров

Структура файлов

📄 SKILL.md