Навыки designing-apis
📦

designing-apis

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

Проектируйте более качественные API-контракты

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

Поддерживает: Claude Codex Code(CC)
Maintain this Skill? Claim it 🥉 79 Бронза

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

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

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

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

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

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

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

Использование «designing-apis». Спроектируй endpoints для сервиса тикетов поддержки клиентов.

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

  • Определяет ресурсы тикетов, комментариев, назначений и вложений.
  • Сопоставляет операции списка, создания, обновления, закрытия и повторного открытия с методами REST.
  • Включает пагинацию, заметки по авторизации и рекомендации по ответам с ошибками.

Использование «designing-apis». Проверь API-контракт для биллингового сервиса.

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

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

Использование «designing-apis». Спланируй GraphQL API для профилей пользователей.

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

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

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

Безопасно

This skill is a static Markdown reference guide for designing REST and GraphQL APIs. All 36 static findings are false positives: the flagged patterns are Markdown code fences misread as shell/Ruby backtick execution, an example placeholder URL, and REST/OpenAPI documentation snippets misread as system reconnaissance. There is no executable code, no network activity, no filesystem or environment access, and no prompt-injection content. The skill is safe.

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

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

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

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

https://skillstore.io/skills/cloudai-x-designing-apis/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Значок Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/cloudai-x-designing-apis/security.svg)](https://skillstore.io/skills/cloudai-x-designing-apis?utm_source=security_passport_badge)

Значок HTML

<a href="https://skillstore.io/skills/cloudai-x-designing-apis?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/cloudai-x-designing-apis/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

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

<iframe src="https://skillstore.io/embed/skills/cloudai-x-designing-apis.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

CloudAI-X. (2026). designing-apis security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/cloudai-x-designing-apis/audits/9

Цитата BibTeX

@techreport{cloudai-x-cloudai-x-designing-apis-2026, author = {CloudAI-X}, title = {designing-apis security audit report (audit version 9)}, institution = {Skillstore}, year = {2026}, number = {9}, url = {https://skillstore.io/skills/cloudai-x-designing-apis/audits/9}, 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: "designing-apis security audit report (audit version 9)" version: "unspecified" type: report authors: - name: "CloudAI-X" date-released: "2026-07-18" url: "https://skillstore.io/skills/cloudai-x-designing-apis/audits/9" identifiers: - type: other value: "skillstore:cloudai-x-designing-apis:audit:9" description: "Skillstore immutable audit report identifier"

Оценка Skillstore

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

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

Спланировать новый продуктовый API

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

Проверить API-контракт

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

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

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

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

Создать базовый REST API
Спроектируй REST API для [product area]. Включи ресурсы, endpoints, методы, коды состояния и простые описания ответов.
Добавить ошибки и пагинацию
Проверь эту идею API: [description]. Добавь пагинацию, ошибки валидации, потребности в аутентификации, ограничения частоты запросов и согласованные правила ответов.
Сравнить REST и GraphQL
Для [use case] сравни дизайны REST и GraphQL. Порекомендуй один подход и объясни компромиссы endpoints или схемы.
Подготовить ревью OpenAPI
Проведи аудит этого API-контракта по именованию, безопасности, версионированию, обработке ошибок, пагинации и пробелам в документации. Верни приоритизированные изменения.

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

  • Начинайте с ресурсов и связей между ними, прежде чем выбирать пути endpoints.
  • Используйте согласованные обертки ответов, коды состояния и детали ошибок.
  • Документируйте аутентификацию, авторизацию, пагинацию и версионирование на раннем этапе.

Избегать

  • Не проектируйте endpoints вокруг глаголов, когда ресурсы дают более понятную модель.
  • Не раскрывайте чувствительные данные в URL или сообщениях об ошибках.
  • Не публикуйте API-контракт без валидации и ревью.

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

Генерирует ли этот навык код реализации?
Нет. Он сосредоточен на проектировании API, контрактах, документации и рекомендациях по ревью.
Может ли он помочь и с REST, и с GraphQL?
Да. Он включает паттерны REST endpoints и паттерны проектирования схем GraphQL.
Включает ли он рекомендации по OpenAPI?
Да. Он ссылается на шаблон OpenAPI 3.0 и рекомендует шаги валидации.
Может ли он проверить существующий API?
Да. Предоставьте контракт или список endpoints, затем попросите найти пробелы и улучшения.
Охватывает ли он безопасность API?
Да. Он охватывает HTTPS, аутентификацию, авторизацию, валидацию, ограничения частоты запросов и обработку чувствительных данных.
Должны ли команды валидации запускаться автоматически?
Нет. Команды, которые устанавливают или выполняют пакеты, должны запускаться только после явного одобрения пользователя.

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

Автор

CloudAI-X

Лицензия

MIT

Ревизия Skillstore

r2

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

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

Ссылка

c68df504887c54bf71d2d467a1fbebde49467868

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

23.07.2026

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

5 загрузок · 212 просмотров

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

Больше от CloudAI-X

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

optimizing-performance

78

Оптимизация производительности приложения

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

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

parallel-execution

78

Координация параллельных AI-субагентов

Сложные проекты часто содержат независимые задачи, которые отнимают время при последовательном выполнении. Этот навык показывает, как планировать, запускать, собирать и синтезировать работу параллельных субагентов.

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

api-design-framework

80

Проектируйте API-контракты, готовые к промышленной эксплуатации

от ArieGoldkin

Команды часто проектируют API с несогласованными ресурсами, ошибками и подходами к версионированию. Этот навык предоставляет паттерны, чек-листы и шаблоны для работы с REST, GraphQL, gRPC, OpenAPI и AsyncAPI.

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

python-fastapi-patterns

85

Создание API на FastAPI с переиспользуемыми паттернами

от 0xDarkMatter

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

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

senior-backend

82

Создавайте надежные бэкенд API

от alirezarezvani

Бэкенд-проекты часто требуют согласованного планирования API, баз данных, безопасности и развертывания. Этот навык дает Claude, Codex и Claude Code структурированные рекомендации по бэкенду с простыми вспомогательными скриптами и справочными материалами.

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

tool-design

81

Проектирование надежных инструментов для агентов

от Asmayaseen

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

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