Навыки api-design-principles

🧭

api-design-principles

Name: api-design-principles
Author: wshobson

Безопасно 🌐 Доступ к сети⚙️ Внешние команды

Проектируйте REST и GraphQL API с уверенностью

Решения по проектированию API часто становятся непоследовательными и сложными для поддержки. Этот навык предоставляет четкие шаблоны, образцы и контрольные списки для направления ваших решений.

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

🥉 72 Бронза

Скачать ZIP навыка

Загрузить в Claude

Перейдите в Settings → Capabilities → Skills → Upload skill

Включите и начните использовать

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

Использование «api-design-principles». Review my user and order endpoints for REST best practices.

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

Use plural nouns: /api/users and /api/orders
Replace action paths like /api/createUser with POST /api/users
Add pagination to list endpoints with page and page_size
Return 201 Created on successful POST and 204 on DELETE

Использование «api-design-principles». How should I structure a GraphQL schema for a blog with users, posts, and comments?

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

Define User, Post, Comment types with proper relationships
Use Relay-style cursor pagination for collections
Create input types for mutations with error payloads
Add DataLoaders to prevent N+1 queries on relationships

Использование «api-design-principles». What status codes should my API return for validation errors?

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

Return 400 Bad Request for malformed request syntax
Return 422 Unprocessable Entity for validation failures
Include field-level error details in the response body
Use consistent error format across all endpoints

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

Безопасно

v4 • 1/17/2026

This skill contains only educational documentation, code templates, and best practices for API design. All 233 static findings are false positives: 'weak cryptographic algorithm' flags educational password hashing examples; 'backtick execution' misinterprets markdown code formatting; 'system reconnaissance' triggers on legitimate programming terms like fetch/decode; hardcoded URLs/IPs are documentation examples, not actual network calls. No executable code, network calls, or data access patterns pose security risks.

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

2,011

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

находки

Всего аудитов

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

🌐 Доступ к сети (7)

assets/rest-api-template.py:182 references/rest-best-practices.md:132 references/rest-best-practices.md:133 references/rest-best-practices.md:134 references/rest-best-practices.md:135 references/rest-best-practices.md:324 skill-report.json:6

⚙️ Внешние команды (134)

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

Оценка качества

Архитектура

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

Контент

Сообщество

100

Безопасность

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

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

Определение новых стандартов API

Создайте последовательные правила REST и GraphQL для команды перед реализацией.

Проверка спецификаций API

Проверьте спецификации на предмет именования, версионирования и проблем обработки ошибок.

Улучшение удобства использования API

Уточните эндпоинты и схему для уменьшения путаницы у клиентов и доработок.

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

Обзор основ REST

Просмотрите этот план REST API и перечислите исправления для именования, методов и кодов статуса. Предоставьте краткий исправленный пример.

Проверка схемы GraphQL

Оцените эту схему GraphQL на предмет пагинации, входных типов и паттернов ошибок. Предложите улучшения с краткими примерами.

Стратегия версионирования

Рекомендуйте подход к версионированию для этого API и объясните компромиссы. Предоставьте контрольный список миграции.

Прогон контрольного списка проектирования

Примените контрольный список проектирования API к этой спецификации и верните результат пройдено/не пройдено с исправлениями для каждого не пройденного пункта.