axum-restful

A restful framework based on axum and sea-orm. Inspired by django-rest-framework.

The goal of the project is to build an enterprise-level production framework.

Features

• a Trait for the struct generated by sea-orm to provide with GET, PATCH, PUT, DELETE methods
• tls support
• prometheus metrics and metrics server
• graceful shutdownsupport
• swagger document generate based on aide

Quick start

A full example is exists at axum-restful/examples/demo.

First, you can create a new crate like cargo new axum-restful-demo.

Build a database service

You should have a database service before. It is recommended to use postgresql database.

you can use docker and docker compose to start a postgresql

create a compose.yaml in the same directory as Cargo.toml

```yaml services: postgres: image: postgres:15-bullseye containername: demo-postgres restart: always volumes: - demo-postgres:/var/lib/postgresql/data ports: - "127.0.0.1:5432:5432" environment: - POSTGRESDB=${POSTGRESDB} - POSTGRESUSER=${POSTGRESUSER} - POSTGRESPASSWORD=${POSTGRES_PASSWORD}

volumes: demo-postgres: {} ```

a .envfile like

```

config the base pg connect params

POSTGRESDB=demo POSTGRESUSER=demo-user POSTGRES_PASSWORD=demo-password

used by axum-restful framework to specific a database connection

DATABASEURL=postgres://${POSTGRESUSER}:${POSTGRESPASSWORD}@localhost:5432/${POSTGRESDB} ```

finally, you can build a service with docker compose up -d

Write and migrate a migration

For more details, please refer to the sea-orm documentation.

Install the sea-orm-cli with cargo

shell $ cargo install sea-orm-cli

Configure dependencies and workspace in Cargo.toml

```toml [workspace] members = [".", "migration"]

[dependencies] tracing = "0.1" tracing-subscriber = "0.3" axum-restful = "0.3" axum = "0.6" migration = { path = "./migration"} sea-orm-migration = {version = "0.11.1", features = ["sqlx-postgres", "runtime-tokio-rustls",]} sea-orm = { version = "0.11", features = ["macros", "sqlx-postgres", "runtime-tokio-rustls"] } serde_json = "1.0" serde = { version = "1.0", features = ["derive"] } tokio = { version = "1", features = ["full"]} schemars = "0.8.12" aide = "0.10.0" ```

Setup the migration directory in ./migration

shell $ sea-orm-cli migrate init

project structure changed into

├── Cargo.lock ├── Cargo.toml ├── compose.yaml ├── migration │   ├── Cargo.toml │   ├── README.md │   └── src │   ├── lib.rs │   ├── m20220101_000001_create_table.rs │   └── main.rs └── src └── main.rs

edit the m20****_******_create_table.rs file blow ./migration/src

```rust use seaormmigration::prelude::*;

[derive(DeriveMigrationName)]

pub struct Migration;

[asynctrait::asynctrait]

impl MigrationTrait for Migration { async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> { // Replace the sample below with your own migration scripts manager .createtable( Table::create() .table(Student::Table) .ifnotexists() .col( ColumnDef::new(Student::Id) .biginteger() .notnull() .autoincrement() .primarykey(), ) .col(ColumnDef::new(Student::Name).string().notnull()) .col(ColumnDef::new(Student::Region).string().notnull()) .col(ColumnDef::new(Student::Age).smallinteger().notnull()) .toowned(), ) .await }

async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
    // Replace the sample below with your own migration scripts

    manager
        .drop_table(Table::drop().table(Student::Table).to_owned())
        .await
}

}

/// Learn more at https://docs.rs/sea-query#iden

[derive(Iden)]

enum Student { Table, Id, Name, Region, Age, } ```

edit migration/Cargo.toml to add dependencies

toml [dependencies] ... axum-restful = "0.3"

edit migration/src/main.rs to specific a database connection an migrate

```rust use seaormmigration::prelude::*;

[async_std::main]

async fn main() { // cli::runcli(migration::Migrator).await; let db = axumrestful::getdbconnection_pool().await; migration::Migrator::up(db, None).await.unwrap(); } ```

migrate the migration files

shell $ cd migration $ cargo run

finally, you can see two tables named sql_migrations and studentgenerated.

Generate entities

at the project root path

shell $ sea-orm-cli generate entity -o src/entities

will generate entities configure and code, now project structure changed into

├── Cargo.lock ├── Cargo.toml ├── compose.yaml ├── migration │   ├── Cargo.toml │   ├── README.md │   └── src │   ├── lib.rs │   ├── m20220101_000001_create_table.rs │   └── main.rs └── src ├── entities │   ├── mod.rs │   ├── prelude.rs │   └── student.rs └── main.rs

edit the src/entities/student.rs to add derive Default, Serialize, Deserialize , add default value to id

``rust //!SeaORM` Entity. Generated by sea-orm-codegen 0.11.0

use sea_orm::entity::prelude::*; use serde::{Deserialize, Serialize};

[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq, Serialize, Deserialize, Default)]

[seaorm(tablename = "student")]

pub struct Model { #[seaorm(primarykey)] #[serde(default = "default_id")] pub id: i64, pub name: String, pub region: String, pub age: i16, }

fn default_id() -> i64 { 0 }

[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]

pub enum Relation {}

impl ActiveModelBehavior for ActiveModel {} ```

edit src/main.rs

```rust use axum::Router; use axum_restful::views::ModelView; mod entities; use entities::student;

[tokio::main]

async fn main() { tracing_subscriber::fmt().init(); struct StudentView;

let path = "/api/student";
impl ModelView<student::ActiveModel> for StudentView {}
// get a 
let app = StudentView::http_router(path);

// if you want to generate swagger docs
// impl OperationInput and SwaggerGenerator and change app into http_routers_with_swagger
// you still need to impl the ModelView
impl aide::operation::OperationInput for student::Model {}
impl axum_restful::swagger::SwaggerGenerator<student::ActiveModel> for StudentView {}
let app = StudentView::http_router_with_swagger(path);

let addr = "0.0.0.0:3000";
tracing::info!("listen at {addr}");
axum::Server::bind(&addr.parse().unwrap()).serve(app.into_make_service()).await.unwrap()

} ```

StudentView impl the ModelView<T>, the T is student::ActiveModel that represent the student table configure in the database, if will has full HTTP methods with GET, POST, PUT, PATCH, DELETE.

you can see the server is listen at port 3000

Verify the service

Swagger

if you impl axum_restful::swagger::SwaggerGenerator above, then you can visit http://127.0.0.1:3000/docs/swagger/ at your browser, you will see a swagger document is generated

HTTP Methods

you can use curl or httpie to verify the service

check the https://httpie.io/docs/cli/installation to install httpie , if you have python3 , you can execute sudo python3 -m pip install httpie

POST

use curl

shell $ curl -H "Content-Type: application/json" -d '{"name": "student-1", "region": "south-1", "age": 11}' -X POST http://127.0.0.1:3000/api/student

use httpie

```shell $ echo -n '{"name": "student-1", "region": "south-1", "age": 11}' | http POST http://127.0.0.1:3000/api/student

HTTP/1.1 201 Created content-length: 0 date: Sat, 01 Apr 2023 02:50:41 GMT ```

GET list

```shell $ http GET http://127.0.0.1:3000/api/student

HTTP/1.1 200 OK content-length: 57 content-type: application/json date: Sat, 01 Apr 2023 02:51:41 GMT

[ { "age": 11, "id": 1, "name": "student-1", "region": "south-1" } ]

```

GET detail

```shell $ http GET http://127.0.0.1:3000/api/student/1

HTTP/1.1 200 OK content-length: 55 content-type: application/json date: Sat, 01 Apr 2023 02:52:41 GMT

{ "age": 11, "id": 1, "name": "student-1", "region": "south-1" }

```

PUT detail

```shell $ echo -n '{"name": "student-put-1", "region": "south-put-1", "age": 12, "id": 1}' | http PUT http://127.0.0.1:3000/api/student/1

HTTP/1.1 200 OK content-length: 0 date: Sat, 01 Apr 2023 02:54:10 GMT

and you can get again to verify put result

$ http GET http://127.0.0.1:3000/api/student HTTP/1.1 200 OK content-length: 65 content-type: application/json date: Sat, 01 Apr 2023 02:54:59 GMT

[ { "age": 12, "id": 1, "name": "student-put-1", "region": "south-put-1" } ] ```

PATCH detail

```shell $ echo -n '{"name": "patch-name"}' | http PATCH http://127.0.0.1:3000/api/student/1

HTTP/1.1 200 OK content-length: 0 date: Sat, 01 Apr 2023 02:57:46 GMT

you can get again to verify the patch

$ http GET http://127.0.0.1:3000/api/student

HTTP/1.1 200 OK content-length: 62 content-type: application/json date: Sat, 01 Apr 2023 02:58:03 GMT

[ { "age": 12, "id": 1, "name": "patch-name", "region": "south-put-1" } ]

```

DELETE detail

```shell $ http DELETE http://127.0.0.1:3000/api/student/1

HTTP/1.1 204 No Content date: Sat, 01 Apr 2023 02:59:16 GMT

you can query again to verify

$ http GET http://127.0.0.1:3000/api/student

HTTP/1.1 200 OK content-length: 2 content-type: application/json date: Sat, 01 Apr 2023 02:59:43 GMT

[]

```

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.