mirror of
https://github.com/EasyTier/EasyTier.git
synced 2026-10-08 10:56:13 -08:00
Sijie.Sun
8aca5851f2
https://apifox.com/apidoc/shared-ceda7a60-e817-4ea8-827b-de4e874dc45e implement all backend API
135 lines
5.4 KiB
Rust
135 lines
5.4 KiB
Rust
//! Rust图形验证码，由Java同名开源库[whvcse/EasyCaptcha](https://github.com/ele-admin/EasyCaptcha)移植而来👏，100%纯Rust实现，支持gif、算术等类型。
|
||
//!
|
||
//! Rust Captcha library, which is ported from Java's same-name library [whvcse/EasyCaptcha](https://github.com/ele-admin/EasyCaptcha),
|
||
//! implemented in 100% pure Rust, supporting GIF and arithmetic problems.
|
||
//!
|
||
//! <br/>
|
||
//!
|
||
//! 目前已适配框架 / Frameworks which is adapted now:
|
||
//!
|
||
//! - `axum` + `tower-sessions`
|
||
//!
|
||
//! 更多框架欢迎您提交PR，参与适配🙏 PR for new frameworks are welcomed
|
||
//!
|
||
//! <br/>
|
||
//!
|
||
//! ## 安装 Install
|
||
//!
|
||
//! 请参考Github README为Linux系统安装依赖。
|
||
//!
|
||
//! If you are compiling this project in linux, please refer to README in repository to install
|
||
//! dependencies into you system.
|
||
//!
|
||
//! ## 使用 Usage
|
||
//!
|
||
//! 若您正在使用的框架已适配，您可直接通过[CaptchaUtil](extension::CaptchaUtil)类（并导入相应框架的trait）来使用验证码：
|
||
//!
|
||
//! If your framework is adapted, you can just use [CaptchaUtil](extension::CaptchaUtil) and importing traits of your
|
||
//! framework to use the Captcha:
|
||
//!
|
||
//! ```
|
||
//! use std::collections::HashMap;
|
||
//! use axum::extract::Query;
|
||
//! use axum::response::IntoResponse;
|
||
//! use easy_captcha::captcha::gif::GifCaptcha;
|
||
//! use easy_captcha::extension::axum_tower_sessions::{
|
||
//! CaptchaAxumTowerSessionExt, CaptchaAxumTowerSessionStaticExt,
|
||
//! };
|
||
//! use easy_captcha::extension::CaptchaUtil;
|
||
//! use easy_captcha::NewCaptcha;
|
||
//!
|
||
//! /// 接口：获取验证码
|
||
//! /// Handler: Get a captcha
|
||
//! async fn get_captcha(session: tower_sessions::Session) -> Result<axum::response::Response, axum::http::StatusCode> {
|
||
//! let mut captcha: CaptchaUtil<GifCaptcha> = CaptchaUtil::new();
|
||
//! match captcha.out(&session).await {
|
||
//! Ok(response) => Ok(response),
|
||
//! Err(_) => Err(axum::http::StatusCode::INTERNAL_SERVER_ERROR),
|
||
//! }
|
||
//! }
|
||
//!
|
||
//! /// 接口：验证验证码
|
||
//! /// Handler: Verify captcha codes
|
||
//! async fn verify_captcha(
|
||
//! session: tower_sessions::Session,
|
||
//! Query(query): Query<HashMap<String, String>>,
|
||
//! ) -> axum::response::Response {
|
||
//! // 从请求中获取验证码 Getting code from the request.
|
||
//! if let Some(code) = query.get("code") {
|
||
//! // 调用CaptchaUtil的静态方法验证验证码是否正确 Use a static method in CaptchaUtil to verify.
|
||
//! if CaptchaUtil::ver(code, &session).await {
|
||
//! CaptchaUtil::clear(&session).await; // 如果愿意的话，你可以从Session中清理掉验证码 You may clear the Captcha from the Session if you want
|
||
//! "Your code is valid, thank you.".into_response()
|
||
//! } else {
|
||
//! "Your code is not valid, I'm sorry.".into_response()
|
||
//! }
|
||
//! } else {
|
||
//! "You didn't provide the code.".into_response()
|
||
//! }
|
||
//! }
|
||
//! ```
|
||
//!
|
||
//! 您也可以自定义验证码的各项属性
|
||
//!
|
||
//! You can also specify properties of the Captcha.
|
||
//!
|
||
//! ```rust
|
||
//! use easy_captcha::captcha::gif::GifCaptcha;
|
||
//! use easy_captcha::extension::axum_tower_sessions::CaptchaAxumTowerSessionExt;
|
||
//! use easy_captcha::extension::CaptchaUtil;
|
||
//! use easy_captcha::NewCaptcha;
|
||
//!
|
||
//! async fn get_captcha(session: tower_sessions::Session) -> Result<axum::response::Response, axum::http::StatusCode> {
|
||
//! let mut captcha: CaptchaUtil<GifCaptcha> = CaptchaUtil::with_size_and_len(127, 48, 4);
|
||
//! match captcha.out(&session).await {
|
||
//! Ok(response) => Ok(response),
|
||
//! Err(_) => Err(axum::http::StatusCode::INTERNAL_SERVER_ERROR),
|
||
//! }
|
||
//! }
|
||
//! ```
|
||
//!
|
||
//! 项目当前提供了三种验证码实现：[SpecCaptcha](captcha::spec::SpecCaptcha)（静态PNG）、[GifCaptcha](captcha::gif::GifCaptcha)（动态GIF）
|
||
//! 、[ArithmeticCaptcha](captcha::arithmetic::ArithmeticCaptcha)（算术PNG），您可按需使用。
|
||
//!
|
||
//! There is three implementation of Captcha currently, which are [SpecCaptcha](captcha::spec::SpecCaptcha)(static PNG),
|
||
//! [GifCaptcha](captcha::gif::GifCaptcha)(GIF), [ArithmeticCaptcha](captcha::arithmetic::ArithmeticCaptcha)(Arithmetic problems),
|
||
//! you can use them according to your need.
|
||
//!
|
||
//! <br/>
|
||
//!
|
||
//! 自带字体效果 / Fonts shipped
|
||
//!
|
||
//! | 字体/Fonts | 效果/Preview |
|
||
//! |---------------------|------------------------------------------------|
|
||
//! | CaptchaFont::Font1 |  |
|
||
//! | CaptchaFont::Font2 |  |
|
||
//! | CaptchaFont::Font3 |  |
|
||
//! | CaptchaFont::Font4 |  |
|
||
//! | CaptchaFont::Font5 |  |
|
||
//! | CaptchaFont::Font6 |  |
|
||
//! | CaptchaFont::Font7 |  |
|
||
//! | CaptchaFont::Font8 |  |
|
||
//! | CaptchaFont::Font9 |  |
|
||
//! | CaptchaFont::Font10 |  |
|
||
//!
|
||
|
||
#![warn(missing_docs)]
|
||
#![allow(dead_code)]
|
||
|
||
pub(crate) mod base;
|
||
pub mod captcha;
|
||
pub mod extension;
|
||
mod utils;
|
||
|
||
pub use base::captcha::*;
|
||
|
||
// #[cfg(test)]
|
||
// mod tests {
|
||
// use super::*;
|
||
//
|
||
// #[test]
|
||
// fn it_works() {
|
||
//
|
||
// }
|
||
// }
|