api-and-interface-design
Design Stable APIs and Interfaces
Unclear contracts, inconsistent errors, and unsafe retries make APIs difficult to use and evolve. This skill provides practical patterns for typed interfaces, validation boundaries, compatibility, pagination, and idempotency.
Установить с помощью моего Агента
Скопируйте этот запрос в своего Агента. Он содержит каноническую страницу Skill и манифест.
Review the Skillstore skill "api-and-interface-design" from https://skillstore.io/skills/addyosmani-api-and-interface-design.md and its manifest at https://skillstore.io/api/skills/addyosmani-api-and-interface-design/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Ваш Агент по-прежнему должен показать план и запросить все подтверждения, требуемые политикой безопасности.
Ресурсы для AI-агентов
Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.
Протестировать
Использование «api-and-interface-design». Create a contract for a task service with create, list, update, and delete operations.
Ожидаемый результат:
- Define typed inputs and outputs for each operation.
- Use plural task resources, consistent status codes, structured errors, and paginated list responses.
- Make deletion idempotent and specify behavior for missing tasks.
Использование «api-and-interface-design». Review a charge endpoint that checks for an idempotency key, charges a card, then stores the key.
Ожидаемый результат:
The sequence has a race because concurrent requests can both pass the check. Claim the key with a unique constraint before the charge, compare request hashes, and define a deliberate response for in-flight duplicates.
Использование «api-and-interface-design». Plan a compatible addition of an optional priority field to task creation.
Ожидаемый результат:
Add the optional field without changing existing types or removing fields. Document the default, validate it at the API boundary, update shared types, and add contract tests for old clients.
Аудит безопасности
БезопасноAll 52 static findings are false positives from Markdown backticks, TypeScript template literals, REST examples, and ordinary API terminology. The skill is documentation-only and contains no shell execution, system reconnaissance, prompt injection, or malicious intent.
Факторы риска
⚙️ Внешние команды (46)
Поделиться и цитировать этот отчет
Делитесь версионным отчетом об оценке, нейтральным значком, встраиваемой карточкой и цитатами. Skillstore публикует доказательства, не решая, безопасен ли этот Skill.
Копировать ссылку на отчёт
https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportЗначок Markdown
[](https://skillstore.io/skills/addyosmani-api-and-interface-design?utm_source=security_passport_badge)Значок HTML
<a href="https://skillstore.io/skills/addyosmani-api-and-interface-design?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/addyosmani-api-and-interface-design/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Встраиваемая карточка
<iframe src="https://skillstore.io/embed/skills/addyosmani-api-and-interface-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
addyosmani. (2026). api-and-interface-design security audit report (audit version 2) [Author version unspecified]. Skillstore. https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2Цитата BibTeX
@techreport{addyosmani-addyosmani-api-and-interface-design-2026,
author = {addyosmani},
title = {api-and-interface-design security audit report (audit version 2)},
institution = {Skillstore},
year = {2026},
number = {2},
url = {https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2},
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-and-interface-design security audit report (audit version 2)"
version: "unspecified"
type: report
authors:
- name: "addyosmani"
date-released: "2026-09-19"
url: "https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2"
identifiers:
- type: other
value: "skillstore:addyosmani-api-and-interface-design:audit:2"
description: "Skillstore immutable audit report identifier"
Оценка Skillstore
Почему такая оценка Достоверность доказательств: СреднийЧто вы можете построить
Plan a New REST API
Define resource URLs, typed payloads, error responses, pagination, filters, and compatibility rules before implementation.
Review a Public Interface
Inspect an existing API or module boundary for inconsistent contracts, breaking changes, weak validation, and unsafe retry behavior.
Design Reliable Payment Retries
Model idempotency keys, atomic request claims, payload matching, in-flight duplicates, and unknown outcomes for state-changing operations.
Попробуйте эти промпты
Design a REST API for [resource]. Define endpoints, typed inputs and outputs, status codes, error bodies, pagination, and naming conventions.
Review this API contract for inconsistent response shapes, validation placement, naming, and backward compatibility. Recommend specific changes: [paste contract].
Design an additive migration from [current interface] to [target interface]. Identify consumer risks, compatibility steps, deprecation timing, and verification checks.
Design an idempotent workflow for [operation]. Cover key derivation, unique storage, request hashing, concurrent duplicates, unknown outcomes, retention, and failure recovery.
Лучшие практики
- Define typed contracts before implementation and keep input models separate from output models.
- Validate untrusted data at system boundaries, then keep internal functions aligned with shared types.
- Design state-changing operations for retries, atomic claims, explicit duplicate handling, and durable evidence.
Избегать
- Returning different error shapes across endpoints or exposing internal server details.
- Breaking existing fields, skipping pagination, or adding incompatible changes without a migration path.
- Checking an idempotency key and acting later without an atomic uniqueness guarantee.
Часто задаваемые вопросы
What kinds of interfaces does this skill cover?
Does this skill generate implementation code?
When should validation occur?
How does it approach backward compatibility?
Why are idempotency keys important?
Can it review an existing API?
Сведения для разработчиков
Автор
addyosmaniЛицензия
MIT
Ревизия Skillstore
r2
Примечание о версии
Автор не указал версию.
Ссылка
5d5054f8a23586f9b500fece1cb613a9dffc787b
Актуальность поддержки
19.09.2026
Использование
0 загрузок · 0 просмотров
Структура файлов
📄 SKILL.md