Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onyxframework/http
An opinionated framework for scalable web 🌎
https://github.com/onyxframework/http
crystal framework http-handler modular onyxframework router web websockets
Last synced: about 1 month ago
JSON representation
An opinionated framework for scalable web 🌎
- Host: GitHub
- URL: https://github.com/onyxframework/http
- Owner: onyxframework
- License: mit
- Created: 2017-10-20T11:56:43.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-25T17:33:13.000Z (over 5 years ago)
- Last Synced: 2024-10-27T13:28:34.141Z (about 2 months ago)
- Topics: crystal, framework, http-handler, modular, onyxframework, router, web, websockets
- Language: Crystal
- Homepage: https://onyxframework.com/http
- Size: 679 KB
- Stars: 142
- Watchers: 8
- Forks: 11
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - prism - Light, modular web framework (Web Frameworks)
README
# Onyx::HTTP
[](https://crystal-lang.org/)
[](https://travis-ci.org/onyxframework/http)
[](https://docs.onyxframework.org/http)
[](https://api.onyxframework.org/http)
[](https://github.com/onyxframework/http/releases)
An opinionated framework for scalable web.
## About 👋
Onyx::HTTP is an opinionated HTTP framework for [Crystal language](https://crystal-lang.org/). It features DSL and modules to build modern, scalabale web applications with first-class support for websockets.
## Installation 📥
Add these lines to your application's `shard.yml`:
```yaml
dependencies:
onyx:
github: onyxframework/onyx
version: ~> 0.6.0
onyx-http:
github: onyxframework/http
version: ~> 0.9.0
```
This shard follows [Semantic Versioning v2.0.0](http://semver.org/), so check [releases](https://github.com/onyxframework/http/releases) and change the `version` accordingly.
> Note that until Crystal is officially released, this shard would be in beta state (`0.*.*`), with every **minor** release considered breaking. For example, `0.1.0` → `0.2.0` is breaking and `0.1.0` → `0.1.1` is not.
## Usage 💻
The simplest hello world:
```crystal
require "onyx/http"
Onyx::HTTP.get "/" do |env|
env.response << "Hello, world!"
end
Onyx::HTTP.listen
```
Encapsulated endpoints:
```crystal
struct GetUser
include Onyx::HTTP::Endpoint
params do
path do
type id : Int32
end
end
errors do
type UserNotFound(404)
end
def call
user = Onyx::SQL.query(User.where(id: params.path.id)).first? # This code is part of onyx/sql
raise UserNotFound.new unless user
return UserView.new(user)
end
end
Onyx::HTTP.get "/users/:id", GetUser
```
Encapsulated views:
```crystal
struct UserView
include Onyx::HTTP::View
def initialize(@user : User)
end
json id: @user.id, name: @user.name
end
```
Websocket channels:
```crystal
struct Echo
include Onyx::HTTP::Channel
def on_message(message)
socket.send(message)
end
end
Onyx::HTTP.ws "/", Echo
```
## Documentation 📚
The documentation is available online at [docs.onyxframework.org/http](https://docs.onyxframework.org/http).
## Community 🍪
There are multiple places to talk about Onyx:
* [Gitter](https://gitter.im/onyxframework)
* [Twitter](https://twitter.com/onyxframework)
## Support ❤️
This shard is maintained by me, [Vlad Faust](https://vladfaust.com), a passionate developer with years of programming and product experience. I love creating Open-Source and I want to be able to work full-time on Open-Source projects.
I will do my best to answer your questions in the free communication channels above, but if you want prioritized support, then please consider becoming my patron. Your issues will be labeled with your patronage status, and if you have a sponsor tier, then you and your team be able to communicate with me privately in [Twist](https://twist.com). There are other perks to consider, so please, don't hesistate to check my Patreon page:
You could also help me a lot if you leave a star to this GitHub repository and spread the word about Crystal and Onyx! 📣
## Contributing
1. Fork it ( https://github.com/onyxframework/http/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'feat: some feature') using [Angular style commits](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit)
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
- [Vlad Faust](https://github.com/vladfaust) - creator and maintainer
## Licensing
This software is licensed under [MIT License](LICENSE).
[](https://opensource.org/licenses/MIT)