golang-api-design

What problem does it solve?

This Skill provides comprehensive guidelines for designing effective and maintainable API surfaces for HTTP and gRPC protocols.

Core Features & Use Cases

• API Structuring: Defines resource naming, versioning, and endpoint conventions.
• Standard Responses: Implements consistent request/response envelopes and error handling.
• Validation & Parsing: Establishes best practices for request decoding, validation, and error responses.
• Pagination & Conditional Requests: Incorporates cursor-based pagination and ETag mechanisms.
• OpenAPI & Proto: Supports API definition through OpenAPI spec and gRPC protocol buffers.
• Application: Useful for API designers, backend engineers, and teams building scalable, versioned APIs with best practices.

Quick Start

Use the guidelines to structure your API endpoints, validate requests, and implement versioned, secure, and scalable services.