skills.rest
Kimenzo
KimenzoCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Define RESTful API and TypeScript interface design standards including pagination and versioning strategies.

Updated Feb 27, 2026
Search Tags:#typescript#web development#api design#rest#data modeling#interface design
One-click install
npx skills add https://github.com/Kimenzo/96000Agents --skill api-design-kimenzo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Kimenzo/96000Agents/tree/main/examples/unified-workspace/skills/api-design
Command: npx skills add https://github.com/Kimenzo/96000Agents --skill api-design-kimenzo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides clear, actionable guidelines for designing consistent, maintainable, and developer-friendly RESTful APIs and their corresponding TypeScript interfaces, reducing ambiguity and improving collaboration.

Core Features & Use Cases

  • RESTful Endpoint Design: Covers URL structure, HTTP method usage, and standard response codes.
  • Response Formats: Defines consistent JSON structures for success and error responses.
  • TypeScript Interface Design: Offers best practices for naming conventions, optional fields, and discriminated unions.
  • Pagination & Versioning: Provides strategies for implementing pagination and API versioning.
  • Use Case: When developing a new microservice, use this Skill to ensure all API endpoints adhere to established best practices for consistency and ease of integration.

Quick Start

Use the api-design skill to generate a TypeScript interface for a user profile with optional fields for address and phone number.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a REST API with consistent URL structures and HTTP methods?▼

Design REST APIs by following standardized URL structures, HTTP method usage, and response codes. This ensures consistent endpoint design, reduces ambiguity, and improves developer collaboration across microservices.

What's the best way to structure TypeScript interfaces for API responses?▼

Structure TypeScript interfaces using established naming conventions, optional fields, and discriminated unions. This approach creates maintainable codebases and ensures type safety for JSON response formats.

How should I handle pagination and versioning in REST API development?▼

Implement pagination and versioning strategies in REST API development to manage data payload sizes and maintain backward compatibility. These strategies ensure scalable and maintainable API endpoints over time.

How do I standardize JSON formats for success and error responses in a REST API?▼

Standardize JSON formats for REST APIs by defining consistent structures for both success and error responses. This ensures predictable data modeling and developer-friendly API integration.

Can I use TypeScript discriminated unions for optional API data modeling?▼

Yes, use TypeScript discriminated unions alongside optional fields for API data modeling. This ensures robust interface design and handles varying JSON response payloads safely within your web development workflow.

Related Skills

Explore More Software Engineering Skills→
xloxn69xloxn69
7

type-definitions

Generate TypeScript interfaces, types, enums, and generics from data structure descriptions.

Community
Basic
Ahoo-WangAhoo-Wang
15

fetcher-decorator-service

Define HTTP API services declaratively with TypeScript decorators.

Community
Intermediate
Vivekmano27Vivekmano27

api-docs-generator

Generate OpenAPI 3.0 documentation from NestJS and Django REST Framework codebases.

Community
Advanced
archibatearchibate
6

api-design-principles

Design REST and GraphQL API interfaces with versioning and error formats.

Community
Intermediate