Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

API design conventions v1.0.0

Use this resource to design a consistent, easy-to-evolve REST API

New

  • 58 downloads
  • 124 likes
  • 184 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install api-design-conventions

First time: connect the CLI with

npx --yes palatekit@latest login

The prompt lists rules, each with a confidence score: resource-oriented URLs, versioned paths, cursor pagination, one error shape, idempotency keys and rate limits. You get a framework to give an agent before it writes routes or OpenAPI documentation.

Mostly picked by

Updated November 2, 2026

Card for the “API design conventions” prompt

Details

Works in
Install guides
Generates with
Your agent's model
Licence
CC0-1.0

Similar resources

View all

What you get

  • The full prompt, ready to paste
  • Rules on URLs, errors, pagination and data privacy

Good fit for

  • Starting a public API before its first release
  • Reviewing the routes of an existing service before a major update

Not for

    Tags

    • api
    • rest
    • http

    About

    You say

    “Propose the routes for my order management following these conventions.”

    Card for the “API design conventions” prompt

    Prompt published by f under the CC0-1.0 license, delivered in its original version.

    Show more

    How to use it

    1. Paste the prompt into your assistant or agent
    2. Ask it to design a consistent, easy-to-evolve REST API
    3. Review and adjust the result

    Content preview

    Files

    • api-design-conventions.md1.9 KB
    • LICENSE0.6 KB
    • NOTICE-PALATEKIT.md0.4 KB

    Origin and licence

    Listed unmodified

    Author
    f
    Source
    github.com/f/prompts.chat/blob/cecef6fc73c2c389770695a56252d331981727de/prompts.csv
    Licence
    CC0-1.0

    Notice

    « API Design taste » (f, CC0-1.0) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.