{"id":29151230,"url":"https://github.com/karpeleslab/apirouter","last_synced_at":"2026-02-11T06:31:29.888Z","repository":{"id":65661760,"uuid":"595406739","full_name":"KarpelesLab/apirouter","owner":"KarpelesLab","description":"api router","archived":false,"fork":false,"pushed_at":"2025-02-25T22:37:29.000Z","size":65,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-01T00:08:53.356Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KarpelesLab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-31T02:19:49.000Z","updated_at":"2025-02-25T22:37:26.000Z","dependencies_parsed_at":"2023-02-17T18:45:41.315Z","dependency_job_id":"e1be50e3-1111-40e0-9fbf-98908d88b015","html_url":"https://github.com/KarpelesLab/apirouter","commit_stats":{"total_commits":84,"total_committers":2,"mean_commits":42.0,"dds":"0.011904761904761862","last_synced_commit":"8df82d8aab3a88c2fe79ee1eab2b444a6645e01f"},"previous_names":[],"tags_count":95,"template":false,"template_full_name":null,"purl":"pkg:github/KarpelesLab/apirouter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fapirouter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fapirouter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fapirouter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fapirouter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KarpelesLab","download_url":"https://codeload.github.com/KarpelesLab/apirouter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fapirouter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262870877,"owners_count":23377314,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-01T00:08:55.037Z","updated_at":"2026-02-11T06:31:29.883Z","avatar_url":"https://github.com/KarpelesLab.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![GoDoc](https://godoc.org/github.com/KarpelesLab/apirouter?status.svg)](https://godoc.org/github.com/KarpelesLab/apirouter)\n\n# API Router\n\nA Go package providing a sophisticated REST/RPC API routing framework with support for multiple transport protocols (HTTP, WebSocket, UNIX sockets) and content types (JSON, CBOR).\n\n## Features\n\n- **Multi-Protocol Support**: HTTP, WebSocket, and UNIX socket transports\n- **Multiple Serialization Formats**: JSON (primary), CBOR (binary), URL-encoded, multipart form\n- **Path-Based Routing**: Routes requests via the `pobj` object registry framework\n- **Type-Safe Parameters**: Generic functions for parameter extraction with automatic type conversion\n- **Hook System**: Request and response hooks for middleware-like behavior\n- **WebSocket Broadcasting**: Real-time event distribution with channel subscriptions\n- **GORM Integration**: Built-in pagination scope for database queries\n- **CORS Support**: Automatic CORS header handling\n- **Protected Fields**: Context-aware JSON marshaling to hide sensitive fields\n\n## Installation\n\n```bash\ngo get github.com/KarpelesLab/apirouter\n```\n\n## Quick Start\n\n### HTTP Handler\n\n```go\npackage main\n\nimport (\n    \"net/http\"\n    \"github.com/KarpelesLab/apirouter\"\n)\n\nfunc main() {\n    http.Handle(\"/_api/\", http.StripPrefix(\"/_api\", apirouter.HTTP))\n    http.ListenAndServe(\":8080\", nil)\n}\n```\n\n### With Middleware\n\n```go\n// Add objects to context for all requests\nhttp.Handle(\"/_api/\", apirouter.WithObject(apirouter.HTTP, \"db\", dbInstance))\n\n// Add context values\nhttp.Handle(\"/_api/\", apirouter.WithValue(apirouter.HTTP, \"config\", configInstance))\n```\n\n## Request Routing\n\nRequests are routed using a path format: `Object/id:method`\n\n- `Object`: Navigate the pobj object hierarchy (uppercase first letter)\n- `id`: Load a specific object instance by ID\n- `:method`: Call a static method on the object\n\n### HTTP Method Mapping\n\n| HTTP Method | Action | Description |\n|-------------|--------|-------------|\n| GET/HEAD | Fetch/List | Retrieve object(s) |\n| POST | Create | Create new object |\n| PATCH | Update | Update existing object (requires `Updatable` interface) |\n| DELETE | Delete | Remove object (requires `Deletable` interface) |\n| OPTIONS | CORS | Preflight request handling |\n\n### Examples\n\n```\nGET  /User              → List users\nGET  /User/123          → Fetch user with ID 123\nPOST /User              → Create new user\nPATCH /User/123         → Update user 123\nDELETE /User/123        → Delete user 123\nGET  /User:search       → Call User.search() static method\nPOST /User:authenticate → Call User.authenticate() static method\n```\n\n## Parameter Handling\n\n### Accessing Parameters\n\n```go\nfunc MyHandler(ctx context.Context) (any, error) {\n    // Type-safe parameter retrieval\n    id, ok := apirouter.GetParam[string](ctx, \"id\")\n\n    // With default value\n    limit := apirouter.GetParamDefault[int](ctx, \"limit\", 25)\n\n    // Nested parameters using dot notation\n    city, _ := apirouter.GetParam[string](ctx, \"address.city\")\n\n    return result, nil\n}\n```\n\n### Parameter Sources\n\n- **GET requests**: Query string parameters, or JSON in `_` parameter\n- **POST/PATCH/PUT**: Request body (JSON, CBOR, URL-encoded, or multipart)\n- **URL-encoded/Multipart**: Can include JSON in `_` parameter to override\n\n### Request Size Limits\n\n| Content Type | Max Size |\n|--------------|----------|\n| JSON | 10 MB |\n| URL-encoded | 1 MB |\n| Multipart | 256 MB |\n\n## Request Hooks\n\nHooks allow intercepting requests for authentication, validation, etc.\n\n```go\n// Authentication hook\napirouter.RequestHooks = append(apirouter.RequestHooks, func(c *apirouter.Context) error {\n    token := apirouter.GetHeader(c, \"Authorization\")\n    user, err := validateToken(token)\n    if err != nil {\n        return apirouter.ErrAccessDenied\n    }\n    c.SetUser(user)\n    return nil\n})\n```\n\n### CSRF Validation\n\n```go\n// Mark request as CSRF-validated (typically in a hook)\nc.SetCsrfValidated(true)\n\n// Check CSRF status in handlers\nif apirouter.SecurePost(ctx) {\n    // Request is POST with valid CSRF\n}\n```\n\n## Response Hooks\n\n```go\napirouter.ResponseHooks = append(apirouter.ResponseHooks, func(r *apirouter.Response) error {\n    // Add audit logging, modify response, etc.\n    return nil\n})\n```\n\n## User Management\n\n```go\n// In request hook\nc.SetUser(userObject)\n\n// In handler\nuser := apirouter.GetUser[*MyUser](ctx)\n```\n\n## Returning Errors\n\nUse the `Error` struct for structured error responses:\n\n```go\n// Predefined errors\nreturn nil, apirouter.ErrNotFound\nreturn nil, apirouter.ErrAccessDenied\n\n// Custom errors\nreturn nil, apirouter.ErrBadRequest(\"invalid_email\", \"Email format is invalid\")\nreturn nil, apirouter.ErrForbidden(\"quota_exceeded\", \"User %s has exceeded quota\", username)\n\n// Full error control\nreturn nil, \u0026apirouter.Error{\n    Message: \"Custom error\",\n    Code:    400,\n    Token:   \"custom_error_token\",\n    Info:    map[string]any{\"field\": \"email\"},\n}\n```\n\n### Available Error Helpers\n\n- `ErrBadRequest(token, msg, args...)` - 400\n- `ErrForbidden(token, msg, args...)` - 403\n- `ErrMethodNotAllowed(token, msg, args...)` - 405\n- `ErrInternalServerError(token, msg, args...)` - 500\n- `ErrNotImplemented(token, msg, args...)` - 501\n- `ErrServiceUnavailable(token, msg, args...)` - 503\n\n### Predefined Error Variables\n\n- `ErrNotFound` - 404 Not Found\n- `ErrAccessDenied` - 403 Forbidden\n- `ErrInternal` - 500 Internal Server Error\n- `ErrInsecureRequest` - 400 Bad Request (missing CSRF)\n- `ErrLengthRequired` - 411 Length Required\n- `ErrRequestEntityTooLarge` - 413 Payload Too Large\n\n## WebSocket Support\n\n### Connecting\n\nClients connect to `/_websocket` and send JSON/CBOR messages:\n\n```json\n{\"path\": \"User:list\", \"verb\": \"GET\", \"params\": {\"limit\": 10}}\n```\n\n### Event Subscription\n\n```go\n// Subscribe to events (in handler)\nc.SetListen(\"user_updates\", true)\n\n// Broadcast to all clients listening\napirouter.BroadcastWS(ctx, map[string]any{\n    \"result\": \"event\",\n    \"type\": \"user_updated\",\n    \"data\": userData,\n})\n\n// Send to specific channel\napirouter.SendWS(ctx, \"user_updates\", eventData)\n```\n\n### Progress Updates\n\nSend intermediate progress during long operations:\n\n```go\nfunc LongOperation(ctx context.Context) (any, error) {\n    for i := 0; i \u003c 100; i++ {\n        apirouter.Progress(ctx, map[string]any{\n            \"percent\": i,\n            \"status\": \"processing\",\n        })\n        // ... do work ...\n    }\n    return result, nil\n}\n```\n\n## UNIX Socket RPC\n\nFor local IPC communication:\n\n```go\n// Server\nerr := apirouter.MakeJsonUnixListener(\"/tmp/api.sock\", map[string]any{\n    \"version\": \"1.0\",\n})\n\n// Client sends JSON:\n// {\"path\": \"User:list\", \"params\": {\"limit\": 10}}\n```\n\n## GORM Pagination\n\nBuilt-in pagination scope for GORM queries:\n\n```go\nfunc ListUsers(ctx context.Context) (any, error) {\n    var c *apirouter.Context\n    ctx.Value(\u0026c)\n\n    var users []User\n    // Uses page_no and results_per_page params (max 100)\n    err := db.Scopes(c.Paginate(25)).Find(\u0026users).Error\n    return users, err\n}\n```\n\n## Response Format\n\nStandard JSON response envelope:\n\n```json\n{\n    \"result\": \"success\",\n    \"data\": { ... },\n    \"time\": 0.042,\n    \"request_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}\n```\n\nError response:\n\n```json\n{\n    \"result\": \"error\",\n    \"error\": \"Not found\",\n    \"code\": 404,\n    \"token\": \"error_not_found\",\n    \"time\": 0.001,\n    \"request_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}\n```\n\n### Raw Response Mode\n\nAdd `?raw` to bypass the response envelope and return data directly.\n\n### Pretty Printing\n\nAdd `?pretty` for indented JSON output.\n\n## Extra Response Data\n\nAdd metadata to responses (pagination info, audit trails, etc.):\n\n```go\nc.SetExtraResponse(\"total_count\", 1000)\nc.SetExtraResponse(\"page\", 1)\n\n// Or from context\napirouter.SetExtraResponse(ctx, \"cursor\", nextCursor)\n```\n\n## Caching\n\n```go\n// Enable caching for this response\nc.SetCache(time.Hour)\n```\n\n## Interfaces\n\n### Updatable\n\nImplement for PATCH support:\n\n```go\ntype Updatable interface {\n    ApiUpdate(ctx context.Context) error\n}\n```\n\n### Deletable\n\nImplement for DELETE support:\n\n```go\ntype Deletable interface {\n    ApiDelete(ctx context.Context) error\n}\n```\n\n## Context Values\n\nAccess special values from context:\n\n```go\nvar c *apirouter.Context\nctx.Value(\u0026c)\n\n// Available string keys:\nctx.Value(\"input_json\")    // Raw input JSON\nctx.Value(\"http_request\")  // *http.Request\nctx.Value(\"domain\")        // Request domain\nctx.Value(\"user_object\")   // User object\nctx.Value(\"request_id\")    // Request UUID\n```\n\n## Dependencies\n\n- [github.com/KarpelesLab/pobj](https://github.com/KarpelesLab/pobj) - Object registry and method dispatch\n- [github.com/KarpelesLab/pjson](https://github.com/KarpelesLab/pjson) - Context-aware JSON encoding\n- [github.com/KarpelesLab/webutil](https://github.com/KarpelesLab/webutil) - HTTP utilities\n- [github.com/coder/websocket](https://github.com/coder/websocket) - WebSocket implementation\n- [github.com/fxamacker/cbor/v2](https://github.com/fxamacker/cbor/v2) - CBOR encoding\n- [gorm.io/gorm](https://gorm.io) - ORM (optional, for pagination)\n\n## License\n\nSee LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarpeleslab%2Fapirouter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkarpeleslab%2Fapirouter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarpeleslab%2Fapirouter/lists"}