Add Chapter 3 - GraphQL Integration Example

.github/workflows/main.yml

@@ -21,6 +21,8 @@ jobs:
         run: cargo build --manifest-path bakery-backend/Cargo.toml
       - name: Build rocket-example
         run: cargo build --manifest-path rocket-example/Cargo.toml
+      - name: Build graphql-example
+        run: cargo build --manifest-path graphql-example/Cargo.toml
 
       # Try to build mdbooks
       - name: Install mdbook

Cargo.toml

@@ -1,2 +1,2 @@
 [workspace]
-members = ["bakery-backend", "rocket-example"]
+members = ["bakery-backend", "graphql-example", "rocket-example"]

README.md

@@ -8,6 +8,7 @@ The tutorials contain the following chapters:
 
 1. [**Bakery Backend**](https://www.sea-ql.org/sea-orm-tutorial/ch01-00-build-backend-getting-started.html) - This chapter covers the basics of using SeaORM to interact with the database (a MySQL database is used for illustration). On top of this backend you can build any interface you need.
 2. [**Rocket Integration**](https://www.sea-ql.org/sea-orm-tutorial/ch02-00-integration-with-rocket.html) - This chapter explains how to integrate the SeaORM backend into the Rocket framework to create a web application that provides a web API or even a simple frontend.
+3. [**GraphQL Integration**](https://www.sea-ql.org/sea-orm-tutorial/ch03-00-integration-with-graphql.html) - This chapter extends the RESTful API of the web application in Chapter 2 to a GraphQL API with only one endpoint but enhanced flexibility of query.
 
 [![Discord](https://img.shields.io/discord/873880840487206962?label=Discord)](https://discord.com/invite/uCPdDXzbdv)
 

graphql-example/.gitignore

@@ -0,0 +1 @@
+target

graphql-example/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "graphql-example"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+async-graphql = "4.0.4"
+async-graphql-rocket = "4.0.4"
+rocket = { version = "^0.5.0-rc.2", features = ["json"] }
+sea-orm = { version = "0.8.0", features = [
+    "sqlx-mysql",
+    "runtime-async-std-native-tls",
+    "macros",
+] }
+sea-orm-migration = "0.8.3"
+serde_json = "1.0.81"

graphql-example/src/entities/baker.rs

@@ -0,0 +1,35 @@
+//! SeaORM Entity. Generated by sea-orm-codegen 0.8.0
+
+use async_graphql::SimpleObject;
+use sea_orm::entity::prelude::*;
+
+#[derive(Clone, Debug, PartialEq, DeriveEntityModel, SimpleObject)]
+#[graphql(complex, name = "Baker")]
+#[sea_orm(table_name = "baker")]
+pub struct Model {
+    #[sea_orm(primary_key)]
+    pub id: i32,
+    pub name: String,
+    pub contact_details: Option<Json>,
+    pub bakery_id: i32,
+}
+
+#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
+pub enum Relation {
+    #[sea_orm(
+        belongs_to = "super::bakery::Entity",
+        from = "Column::BakeryId",
+        to = "super::bakery::Column::Id",
+        on_update = "NoAction",
+        on_delete = "NoAction"
+    )]
+    Bakery,
+}
+
+impl Related<super::bakery::Entity> for Entity {
+    fn to() -> RelationDef {
+        Relation::Bakery.def()
+    }
+}
+
+impl ActiveModelBehavior for ActiveModel {}

graphql-example/src/entities/bakery.rs

@@ -0,0 +1,28 @@
+//! SeaORM Entity. Generated by sea-orm-codegen 0.8.0
+
+use async_graphql::SimpleObject;
+use sea_orm::entity::prelude::*;
+
+#[derive(Clone, Debug, PartialEq, DeriveEntityModel, SimpleObject)]
+#[graphql(complex, name = "Bakery")]
+#[sea_orm(table_name = "bakery")]
+pub struct Model {
+    #[sea_orm(primary_key)]
+    pub id: i32,
+    pub name: String,
+    pub profit_margin: f64,
+}
+
+#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
+pub enum Relation {
+    #[sea_orm(has_many = "super::baker::Entity")]
+    Baker,
+}
+
+impl Related<super::baker::Entity> for Entity {
+    fn to() -> RelationDef {
+        Relation::Baker.def()
+    }
+}
+
+impl ActiveModelBehavior for ActiveModel {}

graphql-example/src/entities/mod.rs

@@ -0,0 +1,6 @@
+//! SeaORM Entity. Generated by sea-orm-codegen 0.8.0
+
+pub mod prelude;
+
+pub mod baker;
+pub mod bakery;

graphql-example/src/entities/prelude.rs

@@ -0,0 +1,4 @@
+//! SeaORM Entity. Generated by sea-orm-codegen 0.8.0
+
+pub use super::baker::Entity as Baker;
+pub use super::bakery::Entity as Bakery;

graphql-example/src/main.rs

@@ -0,0 +1,82 @@
+mod entities;
+mod migrator;
+mod schema;
+mod setup;
+
+use async_graphql::{
+    http::{playground_source, GraphQLPlaygroundConfig},
+    EmptySubscription, Schema,
+};
+use async_graphql_rocket::*;
+use rocket::{response::content, *};
+use schema::*;
+use sea_orm::DbErr;
+use setup::set_up_db;
+
+type SchemaType = Schema<QueryRoot, MutationRoot, EmptySubscription>;
+
+#[get("/")]
+fn index() -> String {
+    "Hello, bakeries!".to_owned()
+}
+
+#[rocket::get("/graphql")]
+fn graphql_playground() -> content::RawHtml<String> {
+    content::RawHtml(playground_source(GraphQLPlaygroundConfig::new("/graphql")))
+}
+
+#[rocket::post("/graphql", data = "<request>", format = "application/json")]
+async fn graphql_request(schema: &State<SchemaType>, request: GraphQLRequest) -> GraphQLResponse {
+    request.execute(schema).await
+}
+
+#[launch]
+async fn rocket() -> _ {
+    let db = match set_up_db().await {
+        Ok(db) => db,
+        Err(err) => panic!("{}", err),
+    };
+
+    let schema = Schema::build(QueryRoot, MutationRoot, EmptySubscription)
+        .data(db)
+        .finish();
+
+    rocket::build()
+        .manage(schema)
+        .mount("/", routes![index, graphql_playground, graphql_request])
+        .register("/", catchers![not_found])
+}
+
+#[catch(404)]
+pub fn not_found(req: &Request<'_>) -> String {
+    format!("{} not found.", req.uri())
+}
+
+#[derive(Responder)]
+#[response(status = 500, content_type = "json")]
+struct ErrorResponder {
+    message: String,
+}
+
+#[allow(clippy::from_over_into)]
+impl Into<ErrorResponder> for DbErr {
+    fn into(self) -> ErrorResponder {
+        ErrorResponder {
+            message: self.to_string(),
+        }
+    }
+}
+
+#[allow(clippy::from_over_into)]
+impl Into<ErrorResponder> for String {
+    fn into(self) -> ErrorResponder {
+        ErrorResponder { message: self }
+    }
+}
+
+#[allow(clippy::from_over_into)]
+impl Into<ErrorResponder> for &str {
+    fn into(self) -> ErrorResponder {
+        self.to_owned().into()
+    }
+}

graphql-example/src/migrator/m20220602_000001_create_bakery_table.rs

@@ -0,0 +1,46 @@
+use sea_orm_migration::prelude::*;
+
+pub struct Migration;
+
+impl MigrationName for Migration {
+    fn name(&self) -> &str {
+        "m_20220602_000001_create_bakery_table"
+    }
+}
+
+#[async_trait::async_trait]
+impl MigrationTrait for Migration {
+    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        manager
+            .create_table(
+                Table::create()
+                    .if_not_exists()
+                    .table(Bakery::Table)
+                    .col(
+                        ColumnDef::new(Bakery::Id)
+                            .integer()
+                            .not_null()
+                            .auto_increment()
+                            .primary_key(),
+                    )
+                    .col(ColumnDef::new(Bakery::Name).string().not_null())
+                    .col(ColumnDef::new(Bakery::ProfitMargin).double().not_null())
+                    .to_owned(),
+            )
+            .await
+    }
+
+    async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        manager
+            .drop_table(Table::drop().table(Bakery::Table).to_owned())
+            .await
+    }
+}
+
+#[derive(Iden)]
+pub enum Bakery {
+    Table,
+    Id,
+    Name,
+    ProfitMargin,
+}

graphql-example/src/migrator/m20220602_000002_create_baker_table.rs

@@ -0,0 +1,56 @@
+use sea_orm_migration::prelude::*;
+
+use super::m20220602_000001_create_bakery_table::Bakery;
+
+pub struct Migration;
+
+impl MigrationName for Migration {
+    fn name(&self) -> &str {
+        "m_20220602_000002_create_baker_table"
+    }
+}
+
+#[async_trait::async_trait]
+impl MigrationTrait for Migration {
+    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        manager
+            .create_table(
+                Table::create()
+                    .if_not_exists()
+                    .table(Baker::Table)
+                    .col(
+                        ColumnDef::new(Baker::Id)
+                            .integer()
+                            .not_null()
+                            .auto_increment()
+                            .primary_key(),
+                    )
+                    .col(ColumnDef::new(Baker::Name).string().not_null())
+                    .col(ColumnDef::new(Baker::ContactDetails).json())
+                    .col(ColumnDef::new(Baker::BakeryId).integer().not_null())
+                    .foreign_key(
+                        ForeignKey::create()
+                            .name("fk-baker-bakery_id")
+                            .from(Baker::Table, Baker::BakeryId)
+                            .to(Bakery::Table, Bakery::Id),
+                    )
+                    .to_owned(),
+            )
+            .await
+    }
+
+    async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        manager
+            .drop_table(Table::drop().table(Baker::Table).to_owned())
+            .await
+    }
+}
+
+#[derive(Iden)]
+pub enum Baker {
+    Table,
+    Id,
+    Name,
+    ContactDetails,
+    BakeryId,
+}

graphql-example/src/migrator/mod.rs

@@ -0,0 +1,16 @@
+use sea_orm_migration::prelude::*;
+
+mod m20220602_000001_create_bakery_table;
+mod m20220602_000002_create_baker_table;
+
+pub struct Migrator;
+
+#[async_trait::async_trait]
+impl MigratorTrait for Migrator {
+    fn migrations() -> Vec<Box<dyn MigrationTrait>> {
+        vec![
+            Box::new(m20220602_000001_create_bakery_table::Migration),
+            Box::new(m20220602_000002_create_baker_table::Migration),
+        ]
+    }
+}