升级0.1.1

1.升级了依赖版本，并根据新版本依赖修改了代码结构。
2. 将service集中到独立的service目录下方便管理

Author: ipconfiger

Cargo.lock

@@ -1,29 +1,29 @@
 [package]
 name = "ru_webapi_codebase"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 
 [dependencies]
-axum = "0.6.20"
-clap = "3.2.25"
+axum = "0.8.3"
+clap = { version = "4.5.36", features = ["derive"] }
 ru-di = "0.1.1"
-serde = { version = "1.0.196", features = ["derive"] }
-serde_json = "1.0.113"
-tokio = { version = "1.36.0", features = ["full"] }
-futures = "0.3.30"
-redis = { version = "0.23", features = ["tokio-comp"] }
-reqwest = {version = "0.11.27", default-features = false, features = ["rustls-tls", "serde_json", "json"] }
-chrono = "0.4.38"
-http = "0.2.11"
-log = "0.4.20"
-simple_logger = "4.3.3"
-uuid = { version = "1.10.0", features = ["v4", "fast-rng"] }
+serde = { version = "1.0.219", features = ["derive"] }
+serde_json = "1.0.140"
+tokio = { version = "1.44.2", features = ["full"] }
+futures = "0.3.31"
+redis = { version = "0.29.5", features = ["tokio-comp"] }
+reqwest = {version = "0.12.15", default-features = false, features = ["rustls-tls", "json"] }
+chrono = "0.4.40"
+http = "1.3.1"
+log = "0.4.27"
+simple_logger = "5.0.0"
+uuid = { version = "1.16.0", features = ["v4", "fast-rng"] }
 hmac = "0.12.1"
 sha1 = "0.10.6"
-base64 = "0.21.7"
+base64 = "0.22.1"
 libaes = "0.7.0"
-utoipa = { version = "4.2.3", features = ["axum_extras"] }
-utoipa-rapidoc = { version = "4", features = ["axum"] }
+utoipa = { version = "5.3.1", features = ["axum_extras"] }
+utoipa-rapidoc = { version = "6.0.0", features = ["axum"] }
 aliyun-sts-rust-sdk = { version ="0.1.1", path="/Users/alex/Projects/workspace/aliyun-sts-rust-sdk"}
-sqlx = { version = "0.7.3", default-features = false, features = ["tls-rustls", "runtime-tokio", "postgres", "json", "uuid", "bigdecimal", "macros"] }
+sqlx = { version = "0.7.4", default-features = false, features = ["tls-rustls", "runtime-tokio", "postgres", "json", "uuid", "bigdecimal", "macros"] }
 sqlx_struct_enhanced = { version = "*", path = "/Users/alex/Projects/workspace/sqlx_struct_enhanced", features = ["postgres"] }

Cargo.toml

@@ -0,0 +1,64 @@
+# 自用项目模版，请谨慎使用!
+
+## A：使用方法
+
+### A1: 手动
+
+在release中下载最新的代码，解压后，将文件夹重命名为项目名称
+
+修改 Cargo.toml 中的 name 字段为项目名称
+
+修改 Cargo.toml 中的 version 字段为项目版本号
+
+修改 Cargo.toml 中的 authors 字段为项目作者
+
+修改 Cargo.toml 中的 description 字段为项目描述
+
+在终端进入项目目录，执行以下命令
+```bash
+git init
+git add .
+git commit -m "init"
+git remote add origin <your-repo-url>
+git push -u origin master
+cargo build
+```
+
+如果编译成功，即可即刻进入项目开发阶段
+
+### A2: 使用 cargo-generate
+
+在终端执行以下命令
+```bash
+cargo install cargo-generate
+cargo generate --git [email protected]:ipconfiger/ru_webapi_codebase.git --name <your-project-name>
+cd <your-project-name>
+cargo build
+```
+
+## B: 项目依赖
+
+项目模版中使用了几个私有项目，如果不需要，可以删除 Cargo.toml 中的依赖项
+### aliyun-sts-rust-sdk
+这个项目是阿里云的 sts rust sdk，用于获取阿里云的临时访问凭证，用于访问阿里云的服务，因为阿里云本身没有提供Rust的SDK，所以自己实现了一个
+
+### sqlx_struct_enhanced
+这个项目是自己对sqlx的简单封装，主要是给struct注入了增删改查的方法，方便使用，主要针对自己的使用习惯，你可以删掉换上自己习惯的ORM框架
+
+### rmmp
+这是在同步模型设计到目标代码的生成器，项目在 https://github.com/ipconfiger/rmmp 中，主要用来将models目录下的模型定义同步生成数据库的models结构体，各种接口定义的结构体，返回数据结构的结构体，以及给前端访问接口定义的请求参数和返回值的结构体定义，和Rust代码同步，方便开发。同时也生成了结构体的类关系图，方便在文档中引用。
+!!! 注意：生成UML图依赖了工具 dot_graph，你需要先自己安装
+
+### C: 开发说明
+
+项目模版定义了双层Router结构，方便拆分子项目。
+
+example 为定义的模版子Router结构，最好不要修改
+
+使用的时候使用在 scripts目录下的脚本 create.sh 来创建子Router结构，脚本会自动创建子Router结构。
+
+```bash
+./scripts/create.sh mod <your-sub-router-name>
+```
+
+

README.md

@@ -1,3 +1,9 @@
+StatusResponse:
+  # 状态码
+  @rust String
+  @ts string
+  status: 状态值
+
 LoginResponse:
   # 登陆结果
   @rust String

models/responses.txt

@@ -13,6 +13,9 @@ digraph G {
     fontsize = 8
   ]
 
+  // 定义类
+  StatusResponse [label = "{ -StatusResponse- |+ status :  状态值\l }"]
+  
   // 定义类
   LoginResponse [label = "{ -LoginResponse- |+ token :  令牌\l+ expires :  过期时间\l }"]
 

outputs/response-uml.png

@@ -1,3 +1,7 @@
+interface StatusResponse {
+    status: string;
+    
+}
 interface LoginResponse {
     token: string;
     expires: number;

outputs/response.dot

@@ -2,17 +2,18 @@ use std::net::SocketAddr;
 use std::time::Duration;
 use axum::response::{Html, IntoResponse, Response};
 use axum::{Json, Router};
+use axum::http::{header, Request, StatusCode};
 use axum::middleware::Next;
 use axum::routing::get;
-use http::{header, Request, StatusCode};
+//use http::{header, Request, StatusCode};
 use log::{error, info};
 use serde_json::json;
 use sqlx::postgres::PgPoolOptions;
 use utoipa::OpenApi;
 use utoipa_rapidoc::RapiDoc;
 use crate::errors::ErrResponse;
 use crate::conf::Configuration;
-use crate::example;
+use crate::{example, services};
 use crate::redis::{RedisHolder, RedisSession};
 
 #[derive(Clone)]
@@ -34,7 +35,7 @@ pub async fn init(cfg: &Configuration) {
     ru_di::Di::register(move |_| {
         pool_inner.clone()
     });
-    example::init().await;
+    services::init().await;
 }
 
 pub async fn start_serve(cfg: &Configuration) {
@@ -50,18 +51,13 @@ pub async fn start_serve(cfg: &Configuration) {
         .nest("/example", example::handlers::router(state.clone()))
         .layer(axum::middleware::from_fn(log_request));
     info!("server will start at 0.0.0.0:{}", cfg.port);
-    let serv = axum::Server::bind(&SocketAddr::from(([0, 0, 0, 0], cfg.port)))
-        .serve(app.into_make_service())
-        .await;
-    match serv {
-        Ok(_)=>{
+    if let Ok(listener) = tokio::net::TcpListener::bind(format!("0.0.0.0:{}", cfg.port).as_str()).await {
+        if let Err(e) = axum::serve(listener, app).await {
+            error!("server fault with err:{}", e);
+        }else{
             info!("server stopped normally");
         }
-        Err(err)=>{
-            error!("server fault with err:{}", err);
-        }
     }
-    
 }
 
 async fn not_found() -> Html<String> {
@@ -71,16 +67,16 @@ async fn status()->impl IntoResponse {
     Json(json!({"status": "it works!"}))
 }
 
-async fn log_request<B>(req: Request<B>, next: Next<B>) -> impl IntoResponse {
+async fn log_request(req: Request<axum::body::Body>, next: Next) -> Response {
     info!("{} {}", req.method(), req.uri());
-    next.run(req).await.into_response()
+    next.run(req).await
 }
 
 async fn redoc_js() -> Response {
     Response::builder()
         .status(StatusCode::OK)
         .header(header::CONTENT_TYPE, "application/javascript")
-        .body(axum::body::boxed(axum::body::Full::from(include_str!("../templates/rapidoc-min.js")))).unwrap()
+        .body(axum::body::Body::new::<String>(include_str!("../templates/rapidoc-min.js").to_string())).unwrap()
 }
 
 async fn redoc_ui() -> Html<String> {

outputs/response.ts

@@ -1,53 +1,37 @@
-use clap::{App, Arg, ArgMatches};
+use clap::{Parser, Subcommand};
+
+#[derive(Parser, Debug, Clone)]
+#[command(version, about, long_about = None)]
 pub struct Configuration {
+    #[arg(short, long)]
     pub db_uri: String,
+    #[arg(short, long)]
     pub port: u16,
-    pub redis_uri: String
+    #[arg(short, long)]
+    pub redis_uri: String,
+
+    #[command(subcommand)]
+    pub command: Option<Commands>,
 }
 
-pub fn get_matches() -> ArgMatches {
-    App::new("Server Configuration")
-        .arg(Arg::with_name("port")
-            .short('p')
-            .long("port")
-            .help("服务器运行端口")
-            .required(true)
-            .takes_value(true)
-            .default_value("9527"))
-        .arg(Arg::with_name("redis")
-            .short('r')
-            .long("redis")
-            .help("Redis连接URI")
-            .required(true)
-            .takes_value(true))
-        .arg(Arg::with_name("db_uri")
-            .short('d')
-            .long("db_uri")
-            .help("数据库连接URI")
-            .required(true)
-            .takes_value(true))
-        .arg(Arg::with_name("cmd")
-            .short('c')
-            .long("cmd")
-            .help("执行命令的名字")
-            .required(false)
-            .takes_value(true))
-        .arg(Arg::with_name("serve")
-            .long("serve")
-            .help("运行服务器")
-            .required(false)
-        )
-        .get_matches()
+#[derive(Subcommand, Debug, Clone)]
+pub enum Commands {
+    Serve,
+    Cli
 }
 
-pub fn config_from_matches(matches: &ArgMatches) -> Configuration {
-    let db_uri = matches.get_one::<String>("db_uri").expect("need db_uri");
-    let port = matches.get_one::<String>("port").expect("need port");
-    let redis_uri = matches.get_one::<String>("redis").expect("need redis_uri");
-    Configuration{
-        db_uri: db_uri.to_string(),
-        port: port.parse::<u16>().expect("port must be a number"),
-        redis_uri: redis_uri.to_string(),
-    }
+pub fn get_config() -> Configuration {
+    Configuration::parse()
 }
 
+// pub fn config_from_matches(matches: &ArgMatches) -> Configuration {
+//     let db_uri = matches.get_one::<String>("db_uri").expect("need db_uri");
+//     let port = matches.get_one::<String>("port").expect("need port");
+//     let redis_uri = matches.get_one::<String>("redis").expect("need redis_uri");
+//     Configuration{
+//         db_uri: db_uri.to_string(),
+//         port: port.parse::<u16>().expect("port must be a number"),
+//         redis_uri: redis_uri.to_string(),
+//     }
+// }
+

src/app.rs

@@ -2,14 +2,16 @@ use axum::{Json, Router};
 use axum::routing::get;
 use serde_json::{json, Value};
 use crate::app::AppContext;
-use crate::example::services;
+use crate::services::example_service::ExampleServices;
 use crate::types::{get_serve, APIResult};
+use crate::errors::ErrResponse;
+use crate::response::StatusResponse;
 
 #[utoipa::path(
     get,
     path = "/example/",
     responses(
-            (status = 200, description = "获取文章列表有限条数", body = Response),
+            (status = 200, description = "测试Handler返回Json", body = StatusResponse),
             (status = 500, description = "服务器错误", body = ErrResponse),
             (status = 401, description = "认证失败", body = ErrResponse),
             (status = 403, description = "没有权限", body = ErrResponse)
@@ -18,10 +20,10 @@ use crate::types::{get_serve, APIResult};
         ("bearerAuth" = [])
     )
 )]
-async fn it_works() -> APIResult<Value> {
-    let serv = get_serve::<services::ExampleServices>();
+async fn it_works() -> APIResult<StatusResponse> {
+    let serv = get_serve::<ExampleServices>();
     serv.test().await?;
-    Ok(Json(json!({"status": "it works".to_string()})))
+    Ok(Json(StatusResponse{status: "it works".to_string()}))
 }
 
 // 导出路由