Ngamux

Build and modify HTTP routes and middleware in Go with Ngamux, supporting dynamic paths, request parsing, JSON/form handling, and fluent response writing.

Security Scan

The skill is an instruction-only API/usage reference for a Go HTTP router (Ngamux) and its declared requirements and instructions are consistent with that purpose, though the package provenance is unknown.

Purpose & Capability

Name/description match the SKILL.md content: it documents route definition, middleware, request parsing, and response helpers for a Go router. No unrelated credentials, binaries, or config paths are requested.

Instruction Scope

SKILL.md contains an API-style usage guide and examples for routing and middleware only. It does not instruct the agent to read unrelated files, environment variables, or to transmit data to external endpoints.

Install Mechanism

No install spec and no code files — the skill is instruction-only and will not write or execute code on disk by itself.

Credentials

The skill declares no required environment variables, credentials, or config paths. That matches the documented behavior (a usage guide for a Go library).

Persistence & Privilege

The skill is not marked always:true and uses default invocation settings. It requests no system-level persistence or cross-skill configuration changes.

Assessment

This skill is an API reference/usage guide for a Go HTTP router and appears internally consistent. It does not ask for credentials or install anything. However, the package source/homepage is unspecified — before relying on or importing Ngamux into projects, verify the library's origin (official repository or vendor), review its code/license, prefer pinned versions, and only fetch/install packages from trusted sources (e.g., a known GitHub repo or your internal registry). If you expect the agent to fetch or build this library automatically, confirm what commands it will run (go get / go install) and ensure those network operations are acceptable in your environment.

When to use this skill

Use this skill when the user needs to:

• Define HTTP endpoints: Create new routes for various HTTP methods (e.g., mux.Get("/users/:id", getUserHandler)) including dynamic path segments (/users/{id}) and wildcards (/files/*filePath).
• Implement request preprocessing/postprocessing: Add global middlewares (e.g., for authentication, logging, CORS) or group-specific middlewares to handle requests before they reach the main handler or after they are processed. For example, mux.Use(authMiddleware) or apiGroup.Use(loggingMiddleware).
• Extract incoming data from requests:
  • URL Parameters: Retrieve values from dynamic path segments (e.g., req.Params("id")).
  • Query Parameters: Access query string values (e.g., req.Query("name", "Guest")).
  • Form Data: Parse application/x-www-form-urlencoded or multipart/form-data (e.g., req.FormValue("username"), req.FormFile("image")).
  • JSON Payloads: Decode application/json request bodies into Go structs (e.g., req.JSON(&user)).
• Construct and send various response types:
  • JSON Responses: Send structured data as JSON (e.g., ngamux.Res(rw).Status(http.StatusOK).Json(data)).
  • Text Responses: Send plain text (e.g., ngamux.Res(rw).Status(http.StatusOK).Text("Hello, World!")).
  • HTML Responses: Render HTML templates (e.g., ngamux.Res(rw).Status(http.StatusOK).HTML("template.html", data)).
  • Custom Status Codes: Set specific HTTP status codes for responses.
• Configure router behavior: Adjust global settings like automatically removing trailing slashes (ngamux.WithTrailingSlash()), setting the logging verbosity (ngamux.WithLogLevel(slog.LevelDebug)), or providing custom json.Marshal/json.Unmarshal functions for specific serialization needs.
• Organize routes with grouping: Create nested route groups to apply common path prefixes and middlewares to a set of routes (e.g., /api/v1).
• Debug routing or handler issues: Inspect route definitions, middleware chains, request context, and logging output to diagnose and resolve problems.

Key Functionality

• Route Definition: ngamux provides methods like mux.Get(), mux.Post(), mux.Put(), mux.Delete(), mux.Patch(), mux.Head(), and mux.All() to register http.HandlerFuncs for specific HTTP methods and paths. It supports path parameters (e.g., /{id}) and wildcards (/*filePath). Routes are efficiently stored and matched using a tree-like structure, leveraging the mapping package for optimized key-value storage.
• Middleware Application: The mux.Use() method allows global middleware registration, while mux.Group() and mux.With() enable group-specific middlewares. Middlewares are MiddlewareFunc types that wrap http.HandlerFuncs, allowing for a chain of responsibility pattern. The WithMiddlewares utility from common.go handles the functional chaining.
• Request Handling: The Request struct (wrapped *http.Request) offers convenience methods:
  • Req().Params(key string): Retrieves URL path parameters parsed during routing.
  • Req().Query(key string, fallback ...string): Accesses URL query string parameters.
  • Req().QueriesParser(data any): Automatically binds query parameters to a Go struct using query tags and reflection.
  • Req().FormValue(key string): Gets form field values.
  • Req().FormFile(key string, maxFileSize ...int64): Handles file uploads from multipart forms.
  • Req().JSON(store any): Decodes JSON request bodies into a provided Go interface.
  • Req().Locals(key any, value ...any): Manages request-scoped data in the context.
• Response Handling: The Response struct (wrapped http.ResponseWriter) provides a fluent API for crafting responses:
  • Res(rw).Status(code int): Sets the HTTP status code.
  • Res(rw).Text(data string): Sends text/plain content.
  • Res(rw).JSON(data any): Sends application/json content, using the configured JSON marshaller.
  • Res(rw).HTML(path string, data any): Renders HTML templates using html/template.
• Configuration: Global Config options are set via ngamux.New() and functional options like ngamux.WithTrailingSlash() and ngamux.WithLogLevel(). Custom JSON marshalling/unmarshalling can be provided.
• Route Grouping: The mux.Group(path string) and mux.GroupFunc(path string, router func(mux *Ngamux)) methods allow hierarchical organization of routes, where child groups inherit path prefixes and can apply their own set of middlewares, leading to cleaner code organization and shared logic.