Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blocknotes/kemal-rest-api
Crystal library to create REST API with Kemal
https://github.com/blocknotes/kemal-rest-api
api crystal kemal rest
Last synced: about 2 months ago
JSON representation
Crystal library to create REST API with Kemal
- Host: GitHub
- URL: https://github.com/blocknotes/kemal-rest-api
- Owner: blocknotes
- License: mit
- Archived: true
- Created: 2017-01-15T15:10:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-19T08:34:59.000Z (about 1 year ago)
- Last Synced: 2024-06-21T23:40:36.049Z (3 months ago)
- Topics: api, crystal, kemal, rest
- Language: Crystal
- Homepage:
- Size: 54.7 KB
- Stars: 55
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - kemal-rest-api - A library to create RESTful API with Kemal (Api Builders)
- awesome-crystal - kemal-rest-api - A library to create RESTful API with Kemal (Api Builders)
README
# kemal-rest-api - PROJECT UNMAINTAINED
> *This project is not maintained anymore*
>
> *If you like it or continue to use it fork it please.*
* * *
* * *
A Crystal library to create REST API with Kemal.
See [examples](https://github.com/blocknotes/kemal-rest-api/tree/master/examples) folder for **mysql**, **sqlite3** and **mongo** samples.
**NOTE**: this is a *beta* version, a lot of features and security improvements need to be implemented actually
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
kemal-rest-api:
github: blocknotes/kemal-rest-api
```
## Usage
```ruby
require "db" # dependency required to use CrystalDbModel
require "sqlite3" # dependency required to use CrystalDbModel - alternatives: crystal-mysql, crystal-pg
require "kemal"
require "kemal-rest-api"
class MyModel < KemalRestApi::Adapters::CrystalDbModel
def initialize
super "sqlite3:./db.sqlite3", "my_table"
end
end
module WebApp
res = KemalRestApi::Resource.new MyModel.new, KemalRestApi::ALL_ACTIONS, prefix: "api", singular: "item"
res.generate_routes!
Kemal.run
end
```
Generated routes:
```
GET /api/items
GET /api/items/:id
POST /api/items
PUT /api/items/:id
DELETE /api/items/:id
```
## KemalRestApi::Resource options
- **json** (*Bool*): form payload as JSON instead of formdata, default = true
- **plural** (*String*): plural name of the model, used for routes, default = *singular* pluralized
- **prefix** (*String*): prefix for all API routes, default = ""
- **singular** (*String*): singular name of the model, default = class model name lowercase
## More examples
See [examples](https://github.com/blocknotes/kemal-rest-api/tree/master/examples) folder.
## Notes
*crystal-db* shard is required only if `KemalRestApi::Adapters::CrystalDbModel` is used.
The proposed adapters are basic implementations, you can create easily a model adapter that responds better to your needs. *prepare_params* is used to adjust the create/update parameters.
## Contributors
- [Mattia Roccoberton](http://blocknot.es) - creator, maintainer, Crystal fan :)