{"id":17261340,"url":"https://github.com/takama/bit","last_synced_at":"2025-03-26T10:10:28.696Z","repository":{"id":83313621,"uuid":"105448653","full_name":"takama/bit","owner":"takama","description":"A simplest HTTP router with additional control","archived":false,"fork":false,"pushed_at":"2017-12-05T17:04:57.000Z","size":43,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-31T11:23:28.239Z","etag":null,"topics":["go","golang","http","router"],"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/takama.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","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":"2017-10-01T14:37:44.000Z","updated_at":"2017-10-08T16:04:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"32e2af41-c517-496f-b489-19ae5847313e","html_url":"https://github.com/takama/bit","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takama%2Fbit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takama%2Fbit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takama%2Fbit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takama%2Fbit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/takama","download_url":"https://codeload.github.com/takama/bit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245632423,"owners_count":20647193,"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":["go","golang","http","router"],"created_at":"2024-10-15T07:50:49.850Z","updated_at":"2025-03-26T10:10:28.680Z","avatar_url":"https://github.com/takama.png","language":"Go","readme":"# Bit Router\n\n[![Build Status](https://travis-ci.org/takama/bit.svg?branch=master)](https://travis-ci.org/takama/bit)\n[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/takama/bit/issues)\n[![Go Report Card](https://goreportcard.com/badge/github.com/takama/bit)](https://goreportcard.com/report/github.com/takama/bit)\n[![codecov](https://codecov.io/gh/takama/bit/branch/master/graph/badge.svg)](https://codecov.io/gh/takama/bit)\n\nA simplest HTTP router contains Router interface that compatible with other routers. As well additional Control interface embeds standard http.ResponseWriter and has methods that accelerate access to `Status Code`, `Body`, `URL/Post/JSON` parameters. This router is useful to prepare a RESTful API. Also it is able to prepare JSON output, which bind automatically for relevant types of data.\n\n## Router interface\n\nRouter interface contains base http methods e.g. GET, PUT, POST and allows to assign user defined handlers in regular use cases like `Page not found`, `Method is not allowed`, Recovery from panic case, middleware, etc.\n\n```go\ntype Router interface {\n    GET(path string, f func(Control))\n    PUT(path string, f func(Control))\n    POST(path string, f func(Control))\n    DELETE(path string, f func(Control))\n    HEAD(path string, f func(Control))\n    OPTIONS(path string, f func(Control))\n    PATCH(path string, f func(Control))\n\n    http.Handler\n\n    UseOptionsReplies(bool)\n    SetupNotAllowedHandler(func(Control))\n    SetupNotFoundHandler(func(Control))\n    SetupRecoveryHandler(func(Control))\n    SetupPresetMiddleware(func(method, path string, handler func(Control)) (string, string, func(Control)))\n    SetupMiddleware(func(func(Control)) func(Control))\n    Listen(hostPort string) error\n}\n```\n\n## Control interface\n\nControl interface contains methods that control URL/POST/JSON query parameters, handle request/response and accelerate access to HTTP `Status Code`, `Body`.\n\n```go\ntype Control interface {\n    Request() *http.Request\n    Params() *Params\n    Query(key string) string\n    Code(code int)\n    GetCode() int\n    Body(data interface{})\n\n    http.ResponseWriter\n}\n```\n\n### Examples\n\n- Simplest example (listen static route):\n\n```go\npackage main\n\nimport (\n    \"github.com/takama/bit\"\n)\n\nfunc Hello(c bit.Control) {\n    c.Body(\"Hello world\")\n}\n\nfunc main() {\n    r := bit.NewRouter()\n    r.GET(\"/hello\", Hello)\n\n    // Listen and serve on 0.0.0.0:8080\n    r.Listen(\":8080\")\n}\n```\n\nCheck it:\n\n```sh\ncurl -i http://localhost:8080/hello/\n\nHTTP/1.1 200 OK\nContent-Type: text/plain; charset=utf-8\nDate: Sun, 01 Oct 2017 17:33:50 GMT\nContent-Length: 11\n\nHello world\n```\n\n- Listen dynamic route with parameter:\n\n```go\npackage main\n\nimport (\n    \"github.com/takama/bit\"\n)\n\nfunc main() {\n    r := bit.NewRouter()\n    r.GET(\"/hello/:name\", func(c bit.Control) {\n        c.Body(\"Hello \" + c.Query(\":name\"))\n    })\n\n    // Listen and serve on 0.0.0.0:8080\n    r.Listen(\":8080\")\n}\n```\n\nCheck it:\n\n```sh\ncurl -i http://localhost:8080/hello/John\n\nHTTP/1.1 200 OK\nContent-Type: text/plain; charset=utf-8\nDate: Sun, 01 Oct 2017 17:33:55 GMT\nContent-Length: 10\n\nHello John\n```\n\n- Apply JSON `Content-Type` for all non-string types:\n\n```go\npackage main\n\nimport (\n    \"github.com/takama/bit\"\n)\n\n// Data is helper to construct JSON\ntype Data map[string]interface{}\n\nfunc main() {\n    r := bit.NewRouter()\n    r.PUT(\"/api/v1/db/settings/name/:name/host/:host/port/:port\", func(c bit.Control) {\n        // Get parameters\n        name := c.Query(\":name\")\n        host := c.Query(\":host\")\n        port := c.Query(\":port\")\n\n        // Verify and save name, host, port\n        // ...\n\n        // Show new settings\n        data := Data{\n            \"Database settings\": Data{\n                \"name\": name,\n                \"host\": host,\n                \"port\": port,\n            },\n        }\n        c.Code(http.StatusAccepted)\n        c.Body(data)\n    })\n    // Listen and serve on 0.0.0.0:8080\n    r.Listen(\":8080\")\n}\n```\n\nCheck it:\n\n```sh\ncurl -i -XPUT http://localhost:8080/api/v1/db/settings/name/test/host/localhost/port/3306\n\nHTTP/1.1 201 OK\nContent-Type: application/json\nDate: Sun, 01 Oct 2017 17:33:56 GMT\nContent-Length: 96\n\n{\n  \"Database settings\": {\n    \"name\": \"test\",\n    \"host\": \"localhost\",\n    \"port\": \"3306\"\n  }\n}\n```\n\n## Contributing to the project\n\nSee the [contribution guidelines](docs/CONTRIBUTING.md) for information on how to\nparticipate in the Bit router project by submitting pull requests or issues.\n\n## License\n\n[MIT Public License](https://github.com/takama/bit/blob/master/LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftakama%2Fbit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftakama%2Fbit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftakama%2Fbit/lists"}