{"id":13726242,"url":"https://github.com/inhabitedtype/ocaml-webmachine","last_synced_at":"2025-08-20T02:32:28.116Z","repository":{"id":28368038,"uuid":"31881976","full_name":"inhabitedtype/ocaml-webmachine","owner":"inhabitedtype","description":"A REST toolkit for OCaml","archived":false,"fork":false,"pushed_at":"2021-10-19T11:54:49.000Z","size":343,"stargazers_count":223,"open_issues_count":13,"forks_count":31,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-07T08:24:21.203Z","etag":null,"topics":["http","ocaml","web","webmachine"],"latest_commit_sha":null,"homepage":"","language":"OCaml","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/inhabitedtype.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-09T06:03:10.000Z","updated_at":"2025-02-16T11:17:02.000Z","dependencies_parsed_at":"2022-07-27T13:49:51.903Z","dependency_job_id":null,"html_url":"https://github.com/inhabitedtype/ocaml-webmachine","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/inhabitedtype/ocaml-webmachine","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inhabitedtype%2Focaml-webmachine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inhabitedtype%2Focaml-webmachine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inhabitedtype%2Focaml-webmachine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inhabitedtype%2Focaml-webmachine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inhabitedtype","download_url":"https://codeload.github.com/inhabitedtype/ocaml-webmachine/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inhabitedtype%2Focaml-webmachine/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271254632,"owners_count":24727376,"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","status":"online","status_checked_at":"2025-08-20T02:00:09.606Z","response_time":69,"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":["http","ocaml","web","webmachine"],"created_at":"2024-08-03T01:02:56.673Z","updated_at":"2025-08-20T02:32:27.802Z","avatar_url":"https://github.com/inhabitedtype.png","language":"OCaml","readme":"# ocaml-webmachine\n\nocaml-webmachine is a layer on top of [cohttp][] that implements a\nstate-machine-based HTTP request processor. It's particularly well-suited for\nwriting RESTful APIs. As the name suggests, this is an OCaml port of the\n[webmachine][] project.\n\n[cohttp]: https://github.com/mirage/ocaml-cohttp\n[webmachine]: https://github.com/webmachine/webmachine\n\n[![Build Status](https://travis-ci.com/inhabitedtype/ocaml-webmachine.svg?branch=master)](https://travis-ci.com/inhabitedtype/ocaml-webmachine)\n\n## Installation\n\nInstall the library and its depenencies via [OPAM][opam]:\n\n[opam]: http://opam.ocaml.org/\n\n```bash\nopam install webmachine\n```\n\n## Getting Started\n\nwebmachine implements [this decision diagram][diagram] to determine how an HTTP\nrequest should be handled. This includes validation, authentication, content\nnegotiation, and caching. A resource specifies the decision that should be made\nat each node in the diagram by defining the appropriate method in a `resource`\nsubclass. The correspondence is suggested by the name of the method for now.\nThis will be better-documented in the future.\n\n### Examples\n\nTo build the examples in the [`examples/`][examples_dir] subdirectory:\n\n```bash\ndune build examples/hello_lwt.exe\ndune build examples/crud_lwt.exe\ndune build examples/hello_async.exe\n```\n\n[diagram]: https://raw.githubusercontent.com/webmachine/webmachine/develop/docs/http-headers-status-v3.png\n[examples_dir]: examples/\n\n## Development\n\nTo install development dependencies, pin the package from the root of the\nrepository:\n\n```bash\nopam pin add -n webmachine .\nopam install --deps-only webmachine\n```\n\nAfter this, you may install a development version of the library using the\ninstall command as usual.\n\nFor building and running the tests during development, you will need to install\nthe `oUnit` package and run tests:\n\n```bash\nopam install oUnit\ndune runtest\n```\n\n## License\n\nBSD3, see LICENSE file for its text.\n","funding_links":[],"categories":["OCaml","Web Development"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finhabitedtype%2Focaml-webmachine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finhabitedtype%2Focaml-webmachine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finhabitedtype%2Focaml-webmachine/lists"}