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.

Designing REST API contracts v1.0.0

Use this resource to design REST API contracts with Pydantic v2 and FastAPI

New

  • 371 downloads
  • 138 likes
  • 222 saves

Free

Install with the CLI

In a terminal, from the folder you want:

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

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent designs the endpoints and request and response contracts of a FastAPI API: URL naming, HTTP semantics, XxxCreate, XxxUpdate and XxxResponse schemas, cursor pagination, a standard error format and OpenAPI documentation. It does not write the implementation.

Mostly picked by

Updated November 2, 2026

Card for the “Designing REST API contracts” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • SKILL.md : URL conventions, HTTP methods and schemas
  • references/pydantic-schema-examples.md and endpoint-catalog-template.md : examples and catalogue template

Good fit for

  • You are adding endpoints to an existing API and need to keep it consistent
  • You are standardizing pagination and errors across several routes

Not for

    Tags

    • api
    • rest
    • pydantic
    • pagination

    About

    You say

    “Design the order management endpoints with cursor pagination and standard errors.”

    Card for the “Designing REST API contracts” skill

    Skill published by hieutrtr under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to design REST API contracts with Pydantic v2 and FastAPI
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1.3 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • references/endpoint-catalog-template.md4.1 KB
    • references/pydantic-schema-examples.md7.1 KB
    • SKILL.md14.7 KB

    Origin and licence

    Listed unmodified

    Author
    hieutrtr
    Source
    github.com/hieutrtr/ai1-skills/tree/d8244c1acdb4e4fac55de84dd49887e91bf7b941/skills/api-design-patterns
    Licence
    MIT

    Notice

    « api-design-patterns » (hieutrtr, MIT) 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.