Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mununki/rust_graphql_api_boilerplate
A Boilerplate of GraphQL API built in Rust + Warp + Juniper + Diesel
https://github.com/mununki/rust_graphql_api_boilerplate
boilerplate diesel-rs graphql graphql-api juniper rust warp
Last synced: about 1 month ago
JSON representation
A Boilerplate of GraphQL API built in Rust + Warp + Juniper + Diesel
- Host: GitHub
- URL: https://github.com/mununki/rust_graphql_api_boilerplate
- Owner: mununki
- License: mit
- Created: 2019-02-28T06:00:13.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-09T13:07:07.000Z (over 1 year ago)
- Last Synced: 2024-08-04T08:08:59.875Z (3 months ago)
- Topics: boilerplate, diesel-rs, graphql, graphql-api, juniper, rust, warp
- Language: Rust
- Homepage:
- Size: 32.2 KB
- Stars: 95
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rust GraphQL API Boilerplate
This is a boilerplate built with Rust.
## Features
- DB migration with Diesel
- Sign up
- Sign in
- Change password
- Profile Update
- JSON web token authentication
## Stacks
- Rust
- [Warp](https://github.com/seanmonstar/warp) - Web server framework
- [Juniper](https://github.com/graphql-rust/juniper) - GraphQL library
- [Diesel](https://github.com/diesel-rs/diesel) - ORM
- DB: Postgres
- JSON Web Token : Authentication
## Run
### Without Docker
```shell
$ git clone https://github.com/mattdamon108/rust_graphql_api_boilerplate
$ cd rust_graphql_api_boilerplate
$ echo DATABASE_URL=postgres://username:password@localhost/rust_boilerplate > .env
$ diesel setup
$ diesel migration run
$ cargo run
```
### Build with Docker
```shell
$ docker build -t rust_gql .
$ docker run --rm -d -p 3030:3030 --name running_rust_gql rust_gql
```
> Change the listening port from `127.0.0.1` to `0.0.0.0` in `main.rs`. Because rust GraphQL API in docker container needs to listen to `0.0.0.0` instead of local interface in order for host to access to the API.
> GraphiQL : connect to 127.0.0.1:3030 with browser
## Schema
### Query
```graphql
query {
getMyProfile {
ok
error
user {
id
email
first_name
last_name
bio
avatar
}
}
}
```
> Note: JSON web token is needed to be sent as `authorization` in header.
### Mutation
> Sign Up
```graphql
mutation {
signUp(
email: "[email protected]"
password: "12345678"
firstName: "graphql"
lastName: "rust"
) {
ok
error
user {
id
email
first_name
last_name
bio
avatar
}
}
}
```
> Sign In
```graphql
mutation {
signIn(email: "[email protected]", password: "12345678") {
token
}
}
```
> Change Password
Note: JSON web token is needed to be sent as `authorization` in header.
```graphql
mutation {
changePassword(password: "87654321") {
ok
error
user {
id
email
first_name
last_name
bio
avatar
}
}
}
```
> Change Profile
Note: JSON web token is needed to be sent as `authorization` in header.
```graphql
mutation {
changeProfile(bio: "Rust fan") {
ok
error
user {
id
email
first_name
last_name
bio
avatar
}
}
}
```
## Next to do
- [x] User Sign up
- [x] Hash User Password - with [bcrypt](https://github.com/Keats/rust-bcrypt) crate
- [x] User Sign in based on Token authentication
- [x] User profile Update
- [x] ERROR HANDLING (important!)
- [x] Deploy using Docker after compile
- [ ] Optimizing the multithread
## References
- http://alex.amiran.it/post/2018-08-16-rust-graphql-webserver-with-warp-juniper-and-mongodb.html
- https://github.com/graphql-rust/juniper/tree/master/juniper_warp
- https://blog.jawg.io/docker-multi-stage-build/