Toutes les ressources premium et membres pour 8,99 €/mois, en abonnement sans engagement. Voir les offres

PalateKit

Se connecter
Menu

Demander une ressource

Décrivez en une phrase la ressource qui vous manque. Nous vous écrirons quand elle sera publiée.

0 / 280

Une page, une vidéo ou une image en ligne.

Débloquer PalateKit

Tout débloquer

Offre

Le paiement vaut acceptation de nos conditions générales de vente.

Paiement sécurisé par Stripe. Reçus et factures envoyés par e-mail.

Content de vous revoir

Connectez-vous pour installer, télécharger ou sauvegarder cette ressource. Un compte gratuit suffit pour les ressources gratuites.

Conception d'API JSON : ressources, erreurs et idempotence v1.0.0

Utilisez cette ressource pour concevoir ou relire une API HTTP JSON : ressources, erreurs, pagination et idempotence

Nouveau

  • 458 téléchargements
  • 202 mentions J'aime
  • 117 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install rest-api-design-rules

Sans option, la skill va dans ~/.agents/skills/ ; ajoutez --agent claude-code (ou codex, cursor…) pour viser un agent.

Première fois : connectez la CLI avec

npx --yes palatekit@latest login

L'agent conçoit ou relit une API HTTP JSON selon 52 règles inspirées de l'API de Stripe : modélisation des ressources, identifiants, format des réponses, erreurs, idempotence, versions, pagination et webhooks. Chaque règle explique le pourquoi. Vous obtenez des décisions d'API difficiles à changer plus tard.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Conception d'API JSON : ressources, erreurs et idempotence »

Caractéristiques

Fonctionne dans
Guides d'installation
Génère avec
Le modèle de votre agent
Licence
MIT

Ressources similaires

Tout voir

Ce que vous obtenez

  • references/ : fiches sur les erreurs, leur type, leur code et le statut HTTP
  • references/ : fiches sur la pagination par curseur et le format des paramètres imbriqués

Pour qui

  • Vous définissez l'API publique d'un nouveau service
  • Vos erreurs renvoient des messages différents selon chaque endpoint

Pas pour qui

    Étiquettes

    • api
    • rest
    • json
    • conception
    • stripe

    À propos

    Vous dites

    « Relis cette spécification OpenAPI : les erreurs n'ont pas de code stable et la pagination se fait par numéro de page. »

    Carte de la skill « Conception d'API JSON : ressources, erreurs et idempotence »

    Skill publiée par pproenca sous licence MIT. Fichiers livrés dans leur version d'origine, en anglais.

    Voir plus

    Comment l'utiliser

    1. Installez la skill dans le dossier de skills de votre agent
    2. Demandez à votre agent de concevoir ou relire une API HTTP JSON : ressources, erreurs, pagination et idempotence
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • AGENTS.md13,2 Ko
    • assets/templates/_template.md3,7 Ko
    • gotchas.md0,6 Ko
    • LICENSE1,1 Ko
    • metadata.json1,5 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • references/_sections.md3,3 Ko
    • references/error-doc-url-on-every-error.md3,7 Ko
    • references/error-four-type-enum.md4,2 Ko
    • references/error-http-status-mapping.md4,1 Ko
    • references/error-lowercase-snake-case-codes.md2,8 Ko
    • references/error-message-mandatory-code-optional.md3,8 Ko
    • references/error-top-level-object.md3,6 Ko
    • references/format-bracket-notation-nesting.md3 Ko
    • references/format-cursor-pagination.md3,1 Ko
    • references/format-dot-notation-expansion.md3,2 Ko
    • references/format-expand-parameter.md3,7 Ko
    • references/format-form-encoded-requests.md3,2 Ko
    • references/format-list-envelope.md3,1 Ko
    • references/format-no-total-counts.md2,7 Ko
    • references/idem-24h-ttl.md3,6 Ko
    • references/idem-fail-on-key-reuse.md4,7 Ko
    • references/idem-key-header.md3,9 Ko
    • references/idem-recovery-points.md5 Ko
    • references/idem-scoped-per-account.md3,3 Ko
    • references/naming-american-english.md4 Ko
    • references/naming-boolean-past-tense.md3,5 Ko
    • references/naming-enums-over-booleans.md4,5 Ko
    • references/naming-metadata-pattern.md4,6 Ko
    • references/naming-simple-unambiguous.md4,2 Ko
    • references/naming-snake-case-wire-format.md3,5 Ko
    • references/naming-type-discriminator-polymorphism.md4,7 Ko
    • references/ops-https-only-basic-auth.md4 Ko
    • references/ops-on-behalf-of-header.md4,7 Ko
    • references/ops-prefixed-api-keys.md4,8 Ko
    • references/ops-webhook-at-least-once-handlers-idempotent.md6,4 Ko
    • references/ops-webhook-event-envelope.md5 Ko
    • references/ops-webhook-event-naming.md5,2 Ko
    • references/ops-webhook-signature.md5,6 Ko
    • references/resource-birthdate-hash.md2,5 Ko
    • references/resource-currency-field-not-name.md2,5 Ko
    • references/resource-decimal-suffix-strings.md2,6 Ko
    • references/resource-integer-minor-units.md2,7 Ko
    • references/resource-iso-date-only.md2,3 Ko
    • references/resource-object-discriminator.md2,1 Ko
    • references/resource-opaque-ids.md2,3 Ko
    • references/resource-prefixed-string-ids.md2,3 Ko
    • references/resource-unix-seconds-timestamps.md2,3 Ko
    • references/url-action-verbs-as-subpaths.md2,9 Ko
    • references/url-dedicated-search-endpoint.md3 Ko
    • references/url-no-bulk-endpoints.md3 Ko
    • references/url-plural-collections.md2,3 Ko
    • references/url-post-for-updates.md2,7 Ko
    • references/url-version-in-path-and-header.md2,8 Ko
    • references/ver-account-pinning.md3,8 Ko
    • references/ver-additive-changes.md5 Ko
    • references/ver-dated-versions.md3,4 Ko
    • references/ver-tolerate-unknown.md5,4 Ko
    • references/ver-version-change-modules.md5,1 Ko
    • SKILL.md11,5 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    pproenca
    Source
    github.com/pproenca/dot-skills/tree/cf93c57cac89d6fc3e4194686000411567f5caf3/skills/.experimental/stripe-inspired-api-design-rules
    Licence
    MIT

    Notice

    « stripe-inspired-api-design-rules » (pproenca, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    Avis des utilisateurs

    –

    Aucune note pour l'instant

    Chargement des avis…

    Supprimer votre avis ?

    Votre note et votre commentaire seront retirés de la fiche.