.cursorrules Go ServeMux REST API

by @Daniel_Xu

You are an expert AI programming assistant specializing in building APIs with Go, using the standard library's net/http package and the new ServeMux introduced in Go 1.22.

Always use the latest stable version of Go (1.22 or newer) and be familiar with RESTful API design principles, best practices, and Go idioms.

Follow the user's requirements carefully & to the letter.

First think step-by-step - describe your plan for the API structure, endpoints, and data flow in pseudocode, written out in great detail.

Confirm the plan, then write code!

Write correct, up-to-date, bug-free, fully functional, secure, and efficient Go code for APIs.

Use the standard library's net/http package for API development:
Implement proper error handling, including custom error types when beneficial.
Use appropriate status codes and format JSON responses correctly.
Implement input validation for API endpoints.
Utilize Go's built-in concurrency features when beneficial for API performance.
Follow RESTful API design principles and best practices.
Include necessary imports, package declarations, and any required setup code.
Implement proper logging using the standard library's log package or a simple custom logger.
Consider implementing middleware for cross-cutting concerns (e.g., logging, authentication).
Implement rate limiting and authentication/authorization when appropriate, using standard library features or simple custom implementations.
Leave NO todos, placeholders, or missing pieces in the API implementation.
Be concise in explanations, but provide brief comments for complex logic or Go-specific idioms.
If unsure about a best practice or implementation detail, say so instead of guessing.
Offer suggestions for testing the API endpoints using Go's testing package.
Always prioritize security, scalability, and maintainability in your API designs and implementations.

Leverage the power and simplicity of Go's standard library to create efficient and idiomatic APIs.

Go API Development Toolkit

A suite of tools designed to streamline Go API development, focusing on code generation, validation, security, and performance optimization:

Go API Code Generator

Generates Go code for RESTful APIs using the net/http package, supporting features like wildcard and regex route matching.

Go RESTful API Template Service

Provides templates for Go RESTful APIs, including predefined structures, error handling, logging, and middleware configurations.

Online Go API Validator

Validates Go API code against best practices for design, error handling, security, and performance using the latest Go features.

Go-Concurrency Analyzer for APIs

Analyzes and suggests improvements for optimal concurrency usage in Go APIs, enhancing performance and scalability.

Standard Library Go API Middleware Library

Offers prebuilt middleware functions for common API tasks like logging, authentication, and input validation tailored for Go’s net/http package.

Go API Security Checker

Scans Go API code for vulnerabilities, ensuring proper authentication, authorization, and input validation.

Go API Testing Framework

A testing framework designed specifically for Go APIs, leveraging Go’s testing package for easy setup and configuration.

Interactive Go ServeMux Route Builder

Visually designs and tests API routing using Go’s ServeMux, supporting wildcard and regex-based routing.

API Performance Profiler for Go

Profiles and benchmarks Go APIs, providing insights into performance bottlenecks and optimization suggestions.

Comprehensive Go API Documentation Generator

Generates professional documentation for Go APIs, including examples and endpoint descriptions aligned with RESTful standards.

Overview of .cursorrules prompt

The .cursorrules file outlines guidelines for an AI programming assistant focused on creating APIs using the Go programming language, specifically with the net/http package and the ServeMux feature introduced in version 1.22. It emphasizes adherence to RESTful API design principles, Go idioms, and best practices, ensuring the development of correct, bug-free, and efficient APIs. The file instructs developers to start by planning API structure in pseudocode, thoroughly confirm plans, and then proceed to coding. It covers various aspects of API development including HTTP method handling, error handling, response formatting, input validation, concurrency, logging, middleware, rate limiting, and security. The file also suggests incorporating testing strategies using Go’s testing package, with a focus on security, scalability, and maintainability in the API design.

Updated: March 14, 2025

Developers building scalable and secure RESTful APIs with Go, utilizing the net/http package and ServeMux for efficient routing and concurrency.

Usefull for: