📦

api-design

Name: api-design
Author: Benny9193

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

Проектирование согласованных REST API

Несогласованные API замедляют интеграцию и приводят к ошибкам клиентов. Этот навык предоставляет практические рекомендации по REST для ресурсов, методов, ответов, ошибок, пагинации, версионирования, аутентификации и документации.

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

🥉 78 Бронза

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

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

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

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

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

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

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

Markdown-детали GET /skills/benny9193-api-design.md Подписанный manifest GET /api/skills/benny9193-api-design/manifest Подписанный lockfile GET /api/skills/benny9193-api-design/lockfile

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

Использование «api-design». Спроектируйте эндпоинты пользователей и заказов для коммерческого сервиса.

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

Карта ресурсов с users и orders, рекомендуемыми методами, рекомендациями по вложенным отношениям, выбором кодов состояния и заметками по пагинации.

Использование «api-design». Проверьте маршруты, использующие имена действий, такие как getUser и createOrder.

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

Обзор маршрутов, который заменяет глаголы действий ресурсами во множественном числе и объясняет, какой метод HTTP должен выражать каждое действие.

Использование «api-design». Подготовьте требования к документации для эндпоинта create-user.

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

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

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

Безопасно

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

All 48 static findings are false positives caused by Markdown fences, API examples, and ordinary terminology. The skill contains no executable commands, environment access, prompt injection, or malicious intent.

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

308

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

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

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

Факторы риска

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

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

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

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

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

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

https://skillstore.io/skills/benny9193-api-design/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Значок Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/benny9193-api-design/security.svg)](https://skillstore.io/skills/benny9193-api-design?utm_source=security_passport_badge)

Значок HTML

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

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

<iframe src="https://skillstore.io/embed/skills/benny9193-api-design.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

Benny9193. (2026). api-design security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/benny9193-api-design/audits/9

Цитата BibTeX

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

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

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

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

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

Самая высокая оценка Skillstore

Автор / источник Оценка Skillstore Достоверность доказательств Использование в Skillstore Обновлено

supercent-io Рекомендуется

supercent-io-api-design

Оценка Skillstore 80

Достоверность доказательств Высокий

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

Обновлено

2026-09-09

Benny9193 Текущий

benny9193-api-design

Оценка Skillstore 78

Достоверность доказательств Высокий

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

Обновлено

2026-09-09

Оценка Skillstore

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

Архитектура

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

Контент

Сообщество

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

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

Планирование нового REST API

Создать согласованную структуру эндпоинтов до начала реализации.

Проверка согласованности эндпоинтов

Сравнить предложенные маршруты, коды состояния и структуры ответов с практическими REST-конвенциями.

Стандартизация документации API

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

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

Создать базовые эндпоинты

Спроектируйте REST эндпоинты для этих ресурсов: [resources]. Включите шаблоны URL, методы HTTP и ожидаемые коды состояния при успешном выполнении.

Нормализовать существующие маршруты

Проверьте эти маршруты API на согласованность с REST: [routes]. Предложите ресурсно-ориентированные альтернативы и кратко объясните каждое изменение.

Спроектировать ответы и ошибки

Определите шаблоны ответов и ошибок для этого эндпоинта: [endpoint]. Включите успешные случаи, ошибки валидации, ошибки авторизации и пагинацию, если она нужна.

Провести аудит контракта API

Проведите аудит этого дизайна API на согласованность, версионирование, пагинацию, аутентификацию, ограничение частоты запросов и пробелы в документации: [api summary]. Приоритизируйте исправления с наибольшим эффектом.

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

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

Избегать

Не добавляйте глаголы действий, такие как get или create, в URL ресурсов REST.
Не раскрывайте внутренние модели данных напрямую в публичных ответах.
Не пропускайте пагинацию или ограничение частоты запросов для эндпоинтов коллекций.

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

Генерирует ли этот навык production-код API?

Нет. Он предоставляет рекомендации по проектированию и критерии проверки для REST API.

Может ли он помочь с документами OpenAPI?

Да. Он включает чеклист документации и небольшой пример в стиле OpenAPI.

Поддерживает ли он проектирование GraphQL или gRPC?

Нет. Рекомендации сосредоточены на конвенциях REST API.

Может ли он проверять существующие имена эндпоинтов?

Да. Он может сравнивать маршруты с правилами именования ресурсов, использования методов и согласованности.

Охватывает ли он безопасность API?

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

Кому следует использовать этот навык?

Backend engineers, API reviewers и technical writers могут использовать его, чтобы сделать REST API более согласованными.

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

Автор

Benny9193

Лицензия

MIT

Ревизия Skillstore

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

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

Репозиторий

https://github.com/Benny9193/devflow/tree/master/skills/api-design

Ссылка

8c3e20bba512c392d9b02ee748b18e0b09d4982c

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

24.07.2026

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

8 загрузок · 259 просмотров

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

Создание компонентов Convex

от get-convex

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

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

api-design

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

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

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

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

Факторы риска

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

Значок Markdown

Значок HTML

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

Цитата APA

Цитата BibTeX

CITATION.cff

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

Оценка Skillstore

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

Планирование нового REST API

Проверка согласованности эндпоинтов

Стандартизация документации API

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

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

Избегать

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

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

Больше от Benny9193

tdd

clean-code

code-patterns

solid-principles

Связанные навыки

http-api-cloudbase

backend-api

api-designer

senior-backend

wordpress-plugin-development

convex-create-component