{"id":26939167,"url":"https://github.com/juniorvieira99/jr_httpcodes","last_synced_at":"2026-06-18T23:32:07.692Z","repository":{"id":284195397,"uuid":"954145191","full_name":"JuniorVieira99/jr_httpcodes","owner":"JuniorVieira99","description":"A component for a large logging system that deal with https codes and methods.","archived":false,"fork":false,"pushed_at":"2025-03-24T19:11:05.000Z","size":31,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T14:16:32.610Z","etag":null,"topics":["code-https","http","http-client","http-requests","requests"],"latest_commit_sha":null,"homepage":"","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/JuniorVieira99.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":"2025-03-24T16:19:21.000Z","updated_at":"2025-03-24T19:26:49.000Z","dependencies_parsed_at":"2025-03-24T17:41:15.161Z","dependency_job_id":null,"html_url":"https://github.com/JuniorVieira99/jr_httpcodes","commit_stats":null,"previous_names":["juniorvieira99/jr_httpcodes"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/JuniorVieira99/jr_httpcodes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuniorVieira99%2Fjr_httpcodes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuniorVieira99%2Fjr_httpcodes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuniorVieira99%2Fjr_httpcodes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuniorVieira99%2Fjr_httpcodes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JuniorVieira99","download_url":"https://codeload.github.com/JuniorVieira99/jr_httpcodes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuniorVieira99%2Fjr_httpcodes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34511617,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-18T02:00:06.871Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["code-https","http","http-client","http-requests","requests"],"created_at":"2025-04-02T14:16:34.247Z","updated_at":"2026-06-18T23:32:07.677Z","avatar_url":"https://github.com/JuniorVieira99.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HTTP Codes Library for Go\n\n![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/JuniorVieira99/jr_httpcodes)\n[![GoDoc](https://godoc.org/github.com/JuniorVieira99/jr_httpcodes?status.svg)](https://godoc.org/github.com/JuniorVieira99/jr_httpcodes)\n[![Go Report Card](https://goreportcard.com/badge/github.com/JuniorVieira99/jr_httpcodes)](https://goreportcard.com/report/github.com/JuniorVieira99/jr_httpcodes)\n[![jr_httpcodes_tests](https://github.com/JuniorVieira99/jr_httpcodes/actions/workflows/tests_workflow.yaml/badge.svg)](https://github.com/JuniorVieira99/jr_httpcodes/actions/workflows/tests_workflow.yaml)\n![GitHub](https://img.shields.io/github/license/JuniorVieira99/jr_httpcodes)\n\nA lightweight, type-safe Go library for working with HTTP status codes and HTTP methods. This library provides constants, validation utilities, and human-readable descriptions for all standard HTTP status codes and methods.\n\n## Index\n\n- [Installation](#installation)\n- [Key Features](#key-features)\n- [Quick Start](#quick-start)\n- [Usage Examples](#usage-examples)\n  - [Working with Status Codes](#working-with-status-codes)\n  - [Working with HTTP Methods](#working-with-http-methods)\n- [Documentation](#documentation)\n- [API Reference](#api-reference)\n  - [Status Code Functions](#status-code-functions)\n  - [Method Functions](#method-functions)\n- [Available Constants](#available-constants)\n- [Thread Safety](#thread-safety)\n- [Overall Use](#overall-use)\n- [License](#license)\n\n## Installation\n\n```bash\ngo get github.com/JuniorVieira99/jr_httpcodes\n```\n\n## Key Features\n\n- Type-safe HTTP status codes and methods\n- Human-readable descriptions for all standard HTTP status codes\n- Validation utilities for status codes and methods\n- Thread-safe registration of custom codes and methods\n- Utility functions for debugging and logging\n- **NOTE**: Check the docs folder for detailed information.\n\n## Quick Start\n\n```go\nimport (\n    \"fmt\"\n    \"github.com/JuniorVieira99/jr_httpcodes\"\n)\n\nfunc main() {\n    codes.Ok.Print() // Output: \"OK -\u003e Request succeeded and response contains requested data\"\n}\n```\n\n## Usage Examples\n\n### Working with Status Codes\n\n```go\nimport (\n    \"fmt\"\n    \"github.com/JuniorVieira99/jr_httpcodes\"\n)\n\nfunc main() {\n    \n    // Call a status code\n    code := codes.OK\n\n    // Check status code category\n    if codes.IsSuccess(codes.OK) {\n        fmt.Println(\"This is a success status code\")\n    }\n    \n    // Get description\n    fmt.Println(codes.GetStatusInfo(codes.NotFound))\n    // Output: \"Requested resource could not be found\"\n    \n    // Validate a status code\n    ok := codes.IsValidStatusCode(codes.StatusCode(999))\n    if !ok {\n        fmt.Println(\"Invalid status code\")\n    }\n    \n    // String representation\n    myCode:=codes.InternalServerError.String()\n    // Direct print\n    codes.InternalServerError.Print()\n    // Output: \"500 -\u003e Server encountered unexpected condition\"\n    \n    // Register a custom status code\n    customCode := codes.StatusCode(599)\n    customDesc := codes.Description(\"My Custom Error\")\n    codes.RegisterStatusCode(customCode, customDesc)\n\n    // Delete custom status code\n    codes.DeleteStatusCode(customCode)\n}\n```\n\n### Working with HTTP Methods\n\n```go\nimport (\n    \"fmt\"\n    \"github.com/JuniorVieira99/jr_httpcodes\"\n)\n\nfunc main() {\n    // Call a method\n    method := codes.POST\n\n    // Get method description\n    fmt.Println(codes.GetMethodDescription(method))\n    // Output: \"Send data to server for processing\"\n\n    // String representation\n    methodStr:= codes.GET.String()\n    // Direct print\n    codes.GET.Print()\n    // Output: \"GET -\u003e Retrieve data from server\"\n    \n    // Validate a method\n    err := codes.ValidateMethod(codes.Method(\"INVALID\"))\n    if err != nil {\n        fmt.Println(\"Invalid method\")\n    }\n    \n    // Register a custom method\n    customMethod := codes.Method(\"CUSTOM\")\n    customDesc := codes.Description(\"My Custom Method\")\n    codes.RegisterMethod(customMethod, customDesc)\n\n    // Delete custom method\n    codes.DeleteMethod(customMethod)\n}\n```\n\n## Documentation\n\nFor local documentation check the `docs`folder.\nFor online documentation check the [GoDoc](https://pkg.go.dev/github.com/JuniorVieira99/jr_httpcodes).\n\n## API Reference\n\n### Status Code Functions\n\n| Function | Description |\n|----------|-------------|\n| `IsValidStatusCode(code StatusCode) bool` | Checks if a status code is valid (100-599) |\n| `IsInformational(code StatusCode) bool` | Checks if a code is informational (1xx) |\n| `IsSuccess(code StatusCode) bool` | Checks if a code indicates success (2xx) |\n| `IsRedirection(code StatusCode) bool` | Checks if a code indicates redirection (3xx) |\n| `IsClientError(code StatusCode) bool` | Checks if a code indicates client error (4xx) |\n| `IsServerError(code StatusCode) bool` | Checks if a code indicates server error (5xx) |\n| `ValidateStatusCode(code StatusCode) error` | Returns error for invalid status codes |\n| `GetStatusInfo(code StatusCode) string` | Returns human-readable description |\n| `RegisterStatusCode(code StatusCode, desc Description)` | Registers a custom status code |\n| `DeleteStatusCode(code StatusCode)` | Deletes a custom status code |\n| `String() string` | Returns human-readable representation |\n| `Print() string` | Prints the status code to the console |\n| `CallMap() map[StatusCode]Description` | A map of status codes to status descriptions |\n| `StringStatusCodeMap() string` | Returns a string representation of the status code map |\n| `PrintStatusCodeMap()` | Prints the status code map to the console |\n\n### Method Functions\n\n| Function | Description |\n|----------|-------------|\n| `ValidateMethod(method Method) error` | Returns error for invalid methods |\n| `GetMethodDescription(method Method) string` | Returns human-readable description |\n| `RegisterMethod(method Method, desc Description)` | Registers a custom method |\n| `DeleteMethod(method Method)` | Deletes a custom method |\n| `String() string` | Returns human-readable representation |\n| `Print() string` | Prints the method to the console |\n| `CallMap() map[Method]Description` | A map of method names to method functions |\n| `StringMethodMap() string` | Returns a string representation of the method map |\n| `PrintMethodMap()` | Prints the method map to the console |\n\n## Available Constants\n\nThe library includes constants for all standard HTTP status codes (100-511) and methods (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, CONNECT, TRACE).\n\n**Note**: Check docs for detail information.\n\n## Thread Safety\n\nAll registration functions are thread-safe and can be called from multiple goroutines.\n\n## Tests\n\nTo run tests, use the following command:\n\n```bash\ngo test ./tests\n```\n\n## Overall Use\n\n```go\nimport (\n    \"fmt\"\n    \"github.com/JuniorVieira99/jr_httpcodes\"\n)\nfunc main()\n{\n    // STATUS CODE\n    // ----------------\n\n    // Check status code category\n    if codes.IsSuccess(codes.OK) {\n        fmt.Println(\"This is a success status code\")\n    }\n\n    // Get description\n    fmt.Println(codes.GetStatusInfo(codes.NotFound))\n    // Output: \"Requested resource could not be found\"\n    \n    // Validate a status code\n    err := codes.ValidateStatusCode(codes.StatusCode(999))\n    if err != nil {\n        fmt.Println(\"Invalid status code\")\n    }\n    \n    // String representation\n    fmt.Println(codes.InternalServerError.String())\n    // Output: \"500 -\u003e Server encountered unexpected condition\"\n    \n    // Print status code\n    codes.InternalServerError.Print()\n    // Output: \"500 -\u003e Server encountered unexpected condition\"\n\n    // Register a custom status code\n    codes.RegisterStatusCode(codes.StatusCode(599), codes.Description(\"My Custom Error\"))\n\n    // Delete custom status code\n    codes.DeleteStatusCode(codes.StatusCode(599))\n\n    // METHOD\n    // ----------------\n    \n    // Get method description\n    fmt.Println(codes.GetMethodDescription(codes.POST))\n    // Output: \"Send data to server for processing\"\n    \n    // Validate a method\n    err := codes.ValidateMethod(codes.Method(\"INVALID\"))\n    if err != nil {\n        fmt.Println(\"Invalid method\")\n    }\n    \n    // String representation\n    fmt.Println(codes.GET.String())\n    // Output: \"GET -\u003e Retrieve data from server\"\n    \n    // Register a custom method\n    codes.RegisterMethod(codes.Method(\"CUSTOM\"), codes.Description(\"My Custom Method\")) \n\n    // Delete custom method\n    codes.DeleteMethod(codes.Method(\"CUSTOM\"))\n}\n```\n\n## License\n\nMIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuniorvieira99%2Fjr_httpcodes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuniorvieira99%2Fjr_httpcodes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuniorvieira99%2Fjr_httpcodes/lists"}