skills.rest
TudeOrangBiasa
TudeOrangBiasaCOMMUNITY
Explore all skills by this author →
GitHub

api-architect

Design REST API endpoints with JSON contracts, versioning, pagination, and rate limiting.

Updated Aug 27, 2026
Search Tags:#design#versioning#api#rest#endpoints#contracts
One-click install
npx skills add https://github.com/TudeOrangBiasa/zenithgravity-kit --skill api-architect-tudeorangbiasa
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-architect
Source: https://github.com/TudeOrangBiasa/zenithgravity-kit/tree/main/.agent/skills/api-architect
Command: npx skills add https://github.com/TudeOrangBiasa/zenithgravity-kit --skill api-architect-tudeorangbiasa

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a structured approach to designing API endpoints, ensuring consistency, adherence to best practices, and efficient data handling.

Core Features & Use Cases

  • Endpoint Design: Define clear and consistent API endpoints following RESTful conventions.
  • Data Contracts: Establish precise JSON payload structures for requests and responses.
  • Versioning & Pagination: Implement strategies for API versioning and efficient data retrieval.
  • Use Case: When building a new microservice, use this Skill to define all its public-facing API endpoints, including request/response schemas and error handling.

Quick Start

Use the api-architect skill to design a new GET endpoint for retrieving user profiles.

Frequently Asked Questions about api-architect

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design REST API endpoints with consistent JSON payload contracts?▼

To design REST API endpoints with JSON payload contracts, you establish precise request and response structures, enforce REST conventions, and define data envelope structures for consistent API communication.

What is the best way to plan API versioning and pagination for a new microservice?▼

Planning API versioning and pagination involves implementing strategies for version control and efficient data retrieval. This ensures your microservice can handle evolving endpoints and manage large datasets without performance degradation.

How do I set up API responses with rate limiting and security best practices?▼

Setting up API responses with rate limiting involves enforcing security best practices directly within your endpoint design. This protects your API from abuse while integrating compact HTTP response outputs.

Can I define error handling and data envelopes for RESTful endpoints?▼

Yes, you can define error handling and data envelopes for RESTful endpoints. The process enforces REST conventions and establishes precise JSON payload structures to standardize how errors and data are returned.

When do I need to establish API contracts for request and response schemas?▼

You need to establish API contracts for request and response schemas when building a new microservice or public-facing API. This ensures all endpoints adhere to consistent RESTful conventions and efficient data handling.

Related Skills

Explore More Software Engineering Skills→
TorbenMerraldTorbenMerrald
1

Backend Models

Define and enforce database models and entity schemas across ORM and migration scripts.

Community
Advanced
vijethkumarmpvijethkumarmp

backend

Create typed API endpoints under src/pages/api in Astro.

Community
Intermediate
petbrainspetbrains
13

backend-trpc-openapi

Generate REST endpoints and OpenAPI documentation from tRPC routers.

Official
Intermediate
thepradipthepradip

graphql-expert

Design GraphQL schemas, resolvers, and WebSocket subscriptions.

Community
Advanced