Навыки openapi-spec-generation
📦

openapi-spec-generation

Ревизия содержимого r1 Безопасно ⚙️ Внешние команды🌐 Доступ к сети

Генерация спецификаций OpenAPI

Командам API нужны точные контракты для документации, валидации и генерации SDK. Этот навык предоставляет шаблоны OpenAPI 3.1, образцы и рекомендации по инструментам.

Поддерживает: Claude Codex Code(CC)
Maintain this Skill? Claim it 📊 76 Адекватно

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

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

Запрос агента
Review the Skillstore skill "openapi-spec-generation" from https://skillstore.io/skills/wshobson-openapi-spec-generation.md and its manifest at https://skillstore.io/api/skills/wshobson-openapi-spec-generation/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

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

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

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

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

Использование «openapi-spec-generation». Запрос на документирование API управления пользователями.

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

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

Использование «openapi-spec-generation». Запрос на подготовку спецификации к генерации SDK.

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

  • Чеклист валидации для operation IDs, именования схем, типов медиа и примеров ответов.
  • Рекомендуемые целевые генераторы и решения по именованию пакетов для клиентских библиотек.

Использование «openapi-spec-generation». Запрос на улучшение существующего API-контракта.

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

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

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

Безопасно

The flagged patterns are false positives from Markdown code fences, sample OpenAPI URLs, resource links, UUID schema examples, and generic error responses. No prompt injection, hidden command execution, credential access, or data exfiltration intent was found in SKILL.md.

1
Просканировано файлов
1,029
Проанализировано строк
0
Пункты проверки
0
Ложные срабатывания проигнорированы
Последний завершенный статический и семантический аудит не обнаружил подтвержденных проблем безопасности. Это не доказывает отсутствие побочных эффектов у навыка.
Поделиться и цитировать этот отчет

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

Открыть версионный отчет
Оценка безопасности

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

https://skillstore.io/skills/wshobson-openapi-spec-generation/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Значок Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/wshobson-openapi-spec-generation/security.svg)](https://skillstore.io/skills/wshobson-openapi-spec-generation?utm_source=security_passport_badge)

Значок HTML

<a href="https://skillstore.io/skills/wshobson-openapi-spec-generation?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/wshobson-openapi-spec-generation/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

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

<iframe src="https://skillstore.io/embed/skills/wshobson-openapi-spec-generation.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

wshobson. (2026). openapi-spec-generation security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/wshobson-openapi-spec-generation/audits/8

Цитата BibTeX

@techreport{wshobson-wshobson-openapi-spec-generation-2026, author = {wshobson}, title = {openapi-spec-generation security audit report (audit version 8)}, institution = {Skillstore}, year = {2026}, number = {8}, url = {https://skillstore.io/skills/wshobson-openapi-spec-generation/audits/8}, note = {Author version unspecified} }

CITATION.cff

cff-version: 1.2.0 message: "If you use this Skill, cite its author and this versioned security audit report." title: "openapi-spec-generation security audit report (audit version 8)" version: "unspecified" type: report authors: - name: "wshobson" date-released: "2026-07-08" url: "https://skillstore.io/skills/wshobson-openapi-spec-generation/audits/8" identifiers: - type: other value: "skillstore:wshobson-openapi-spec-generation:audit:8" description: "Skillstore immutable audit report identifier"

Сравнить варианты

2 устанавливаемых вариантов

Навык каждого автора остаётся отдельным устанавливаемым вариантом. Рекомендуемый вариант ранжируется по данным Skillstore.

Почему этот вариант первый

Самая высокая оценка Skillstore
sickn33 Рекомендуется

sickn33-openapi-spec-generation

Оценка Skillstore 78
Достоверность доказательств Высокий
Использование в Skillstore 22
Обновлено

2026-09-09

wshobson Текущий

wshobson-openapi-spec-generation

Оценка Skillstore 76
Достоверность доказательств Высокий
Использование в Skillstore 20
Обновлено

2026-09-09

Оценка Skillstore

Почему такая оценка Достоверность доказательств: Высокий
55
Архитектура
85
Сопровождаемость
87
Контент
71
Сообщество
70
Соответствие спецификации

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

Создать новый API-контракт

Подготовить черновик спецификации OpenAPI 3.1 до реализации, включая пути, тела запросов, ошибки и аутентификацию.

Документировать существующие сервисы

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

Подготовить генерацию SDK

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

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

Начать базовую спецификацию
Создайте черновик OpenAPI 3.1 для простого ресурсного API. Включите пути, схемы, примеры, ошибки и bearer-аутентификацию.
Проверить существующую спецификацию
Проверьте этот файл OpenAPI на отсутствующие operation IDs, неполное покрытие ответов, повторное использование схем и неясные описания.
Сгенерировать из кода
Используйте этот код FastAPI или tsoa, чтобы спроектировать соответствующий контракт OpenAPI. Выделите расхождения между реализацией и документированным поведением.
Построить рабочий процесс валидации
Спроектируйте рабочий процесс валидации для этой спецификации OpenAPI с использованием линтинга, сборки, проверок критических изменений и готовности к генерации SDK.

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

  • Используйте переиспользуемые схемы, параметры, ответы и примеры, чтобы контракт оставался согласованным.
  • Определяйте аутентификацию, авторизацию и ответы с ошибками для каждой защищенной операции.
  • Запускайте проверки линтинга и сборки перед публикацией документации или генерацией SDK.

Избегать

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

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

Создает ли этот навык спецификации OpenAPI 3.1?
Да. Он предоставляет шаблоны и паттерны для путей, схем, ответов, примеров и схем безопасности OpenAPI 3.1.
Может ли он работать с существующим кодом?
Да. Он включает code-first примеры для FastAPI и шаблонов TypeScript tsoa.
Валидирует ли он спецификации автоматически?
Он предоставляет рабочие процессы валидации и примеры команд. Агенту все равно нужны разрешение и подходящие локальные инструменты для их запуска.
Может ли он генерировать клиентские SDK?
Он объясняет, как подготовить и запустить генерацию SDK для клиентов на TypeScript, Python и Go.
Безопасно ли публиковать?
Да, с уведомлением о среднем риске. Примеры команд являются корректными, но пользователям следует проверить их перед выполнением.
Что пользователям следует предоставить для лучших результатов?
Предоставьте эндпоинты API, модели запросов и ответов, правила аутентификации, форматы ошибок и целевые языки SDK.

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

Автор

wshobson

Лицензия

MIT

Ревизия Skillstore

r1

Примечание о версии

Автор не указал версию.

Ссылка

64ca8af0f54a325752f08bd54e52151061ea659a

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

22.07.2026

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

12 загрузок · 242 просмотров

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

📄 SKILL.md

Больше от wshobson

Показать все
📦

prompt-engineering-patterns

86

Оптимизация промптов LLM для продакшена

Промпты LLM часто дают сбой из-за неясных инструкций, примеров и критериев оценки. Этот навык предоставляет шаблоны и рабочие процессы для улучшения промптов в Claude, Codex, Claude Code и похожих инструментах.

Продуктивность Просмотр
📦

context-driven-development

81

Управление разработкой на основе контекста

Проекты с поддержкой ИИ теряют согласованность, когда продуктовые цели, выбор стека и правила рабочего процесса разрознены. Этот навык направляет Claude, Codex и Claude Code с помощью контекстных артефактов Conductor.

Кодинг и разработка Просмотр
📦

startup-financial-modeling

80

Создание финансовых моделей для стартапов

Командам стартапов нужны понятные прогнозы, прежде чем они смогут планировать найм, привлечение финансирования и использование денежных средств. Этот навык структурирует выручку, затраты, runway и сценарии в практические результаты для финансового планирования.

Данные и аналитика Просмотр
📦

kpi-dashboard-design

79

Проектируйте KPI-дашборды, которые помогают принимать решения

Команды часто создают дашборды, которые показывают множество чисел, но не помогают перейти к действию. Этот навык помогает Claude, Codex и Claude Code выбирать значимые KPI, структурировать представления и понятно представлять метрики.

Дизайн и креатив Просмотр
📦

postmortem-writing

79

Пишите безобвинительные постмортемы инцидентов

Разборы инцидентов часто становятся непоследовательными, сфокусированными на поиске виновных или сложными для практического применения. Этот навык помогает Claude, Codex и Claude Code составлять структурированные постмортемы с четкими таймлайнами, корневыми причинами и ответственными.

Письмо и контент Просмотр
📦

data-storytelling

79

Создавайте понятные истории на основе данных

Сырые метрики часто не убеждают заинтересованные стороны и не помогают принимать решения. Этот skill помогает Claude, Codex и Claude Code превращать анализ в понятные повествования, визуализации и рекомендации.

Данные и аналитика Просмотр
Показать все
📦

api-doc-generator

80

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

от zhangchenlai-dev

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

Документация Просмотр