API Development Guide

Design and secure RESTful APIs with best practices and reference schemas.

Updated Dec 29, 2025
One-click install
npx skills add https://github.com/HankHuang0516/wishlist-app --skill api-development-guide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: API Development Guide
Source: https://github.com/HankHuang0516/wishlist-app/tree/main/.agent/skills/api_development
Command: npx skills add https://github.com/HankHuang0516/wishlist-app --skill api-development-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a comprehensive, practical guide for architecting, securing, and validating RESTful APIs. It addresses common design pitfalls and offers actionable patterns to improve interoperability, reliability, and safety across services.

Core Features & Use Cases

  • Design Principles: Clear RESTful conventions, resource modeling, and URL design.
  • HTTP & Status Semantics: Correct use of methods, statuses, and headers for predictable behavior.
  • Security & Auth: Authentication, authorization, and secure defaults including token-based schemes and API keys.
  • Quality & Testing: Techniques for testing, debugging, and validating APIs with documentation artifacts.
  • Use Case: When launching a new wishlist service, apply these practices to model endpoints, secure access, and verify responses with OpenAPI.

Quick Start

  1. Review the REST API principles in the guide.
  2. Document your API endpoints using an OpenAPI specification.
  3. Implement authentication and rate limiting in your API server, then run the included test scenarios.

Frequently Asked Questions about API Development Guide

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

FAQPage Schema
What are the best practices for REST API design and resource modeling?

REST API design best practices involve applying clear RESTful conventions, accurate resource modeling, and proper URL design to improve interoperability and reliability across microservices. Following these architectural principles ensures predictable behavior for both internal and public services.

How do I secure a REST API with authentication and rate limiting?

Secure a REST API by implementing token-based authentication, API keys, and secure authorization defaults to control access. Apply rate limiting to prevent abuse and ensure scalable, reliable service behavior under heavy request loads.

Which HTTP status codes and methods should I use for my REST API?

Use correct HTTP methods and status semantics to ensure predictable REST API behavior. Applying the appropriate HTTP methods, status codes, and headers communicates resource state changes and operation outcomes effectively to clients.

How do I test and validate REST API endpoints using OpenAPI?

Test and validate REST API endpoints by documenting them with an OpenAPI specification and running test scenarios against your implementation. This technique verifies response correctness and validates endpoint behavior during debugging.

Can I apply these REST API patterns to microservices and internal services?

Yes, these REST API patterns apply to API-first projects, microservices, and teams building internal or public services. The architectural principles and security defaults ensure reliable and scalable communication across distributed systems.

What are common REST API security pitfalls and how do I avoid them?

Common REST API security pitfalls include improper authorization and missing rate limiting. Avoid them by applying secure defaults, implementing token-based authentication schemes, and validating API access to ensure safe, reliable operations.