octorust: Rust的GitHub API集成库

概述

octorust是一个Rust库，提供了与GitHub API交互的高效接口，简化了GitHub数据获取和仓库管理操作。它封装了GitHub REST API v3，提供类型安全的Rust接口，支持异步操作。

主要特性

• 完整的GitHub API覆盖（仓库、问题、PRs、用户等）
• 类型安全的请求和响应
• 异步/await支持
• 分页支持
• 自定义请求构建

安装

在Cargo.toml中添加依赖：

[dependencies]
octorust = "0.2"
tokio = { version = "1.0", features = ["full"] }

基本使用方法

1. 创建客户端

use octorust::Client;

#[tokio::main]
async fn main() {
    let user_agent = "my-github-app/1.0";
    let token = std::env::var("GITHUB_TOKEN").expect("GITHUB_TOKEN not set");
    
    let client = Client::new(user_agent, token).unwrap();
}

2. 获取仓库信息

async fn get_repo_info(client: &Client) {
    let owner = "rust-lang";
    let repo = "rust";
    
    match client.repos().get(owner, repo).await {
        Ok(repository) => {
            println!("Repository: {}", repository.name);
            println!("Description: {:?}", repository.description);
            println!("Stars: {}", repository.stargazers_count.unwrap_or(0));
        }
        Err(e) => eprintln!("Error: {}", e),
    }
}

3. 创建Issue

async fn create_issue(client: &Client) {
    let owner = "your-username";
    let repo = "your-repo";
    
    let issue = octorust::types::IssuesCreateRequest {
        title: "Test issue".to_string(),
        body: Some("This is a test issue created with octorust".to_string()),
        assignee: None,
        assignees: None,
        milestone: None,
        labels: None,
    };
    
    match client.issues().create(owner, repo, &issue).await {
        Ok(created_issue) => {
            println!("Created issue #{}: {}", created_issue.number, created_issue.title);
        }
        Err(e) => eprintln!("Error creating issue: {}", e),
    }
}

4. 获取用户信息

async fn get_user_info(client: &Client, username: &str) {
    match client.users().get_by_username(username).await {
        Ok(user) => {
            println!("User: {}", user.login);
            println!("Name: {:?}", user.name);
            println!("Public repos: {}", user.public_repos.unwrap_or(0));
        }
        Err(e) => eprintln!("Error: {}", e),
    }
}

5. 分页获取仓库提交

async fn list_commits(client: &Client) {
    let owner = "rust-lang";
    let repo = "rust";
    let per_page = 30;
    
    let params = octorust::params::repos::ListCommits {
        sha: None,
        path: None,
        author: None,
        since: None,
        until: None,
        page: Some(1),
        per_page: Some(per_page),
    };
    
    match client.repos().list_commits(owner, repo, &params).await {
        Ok(commits) => {
            for commit in commits {
                println!("Commit: {}", commit.sha);
                println!("Message: {}", commit.commit.message);
                println!("Author: {}", commit.commit.author.name);
            }
        }
        Err(e) => eprintln!("Error: {}", e),
    }
}

高级用法

自定义请求

use octorust::http::request::Request;
use octorust::types::Repository;

async fn custom_request(client: &Client) {
    let request = Request::get("/repos/rust-lang/rust")
        .accept("application/vnd.github.v3+json");
    
    match client.execute::<Repository>(request).await {
        Ok(repo) => println!("Repo: {}", repo.name),
        Err(e) => eprintln!("Error: {}", e),
    }
}

处理速率限制

async fn check_rate_limit(client: &Client) {
    match client.rate_limit().get().await {
        Ok(rate_limit) => {
            println!("Remaining requests: {}", rate_limit.resources.core.remaining);
            println!("Reset time: {}", rate_limit.resources.core.reset);
        }
        Err(e) => eprintln!("Error: {}", e),
    }
}

完整示例demo

use octorust::Client;
use octorust::types::IssuesCreateRequest;

#[tokio::main]
async fn main() {
    // 1. 创建客户端
    let user_agent = "my-github-app/1.0";
    let token = std::env::var("GITHUB_TOKEN").expect("GITHUB_TOKEN not set");
    let client = Client::new(user_agent, token).unwrap();
    
    // 2. 获取仓库信息
    async fn get_repo_info(client: &Client) {
        let owner = "rust-lang";
        let repo = "rust";
        
        match client.repos().get(owner, repo).await {
            Ok(repository) => {
                println!("Repository: {}", repository.name);
                println!("Description: {:?}", repository.description);
                println!("Stars: {}", repository.stargazers_count.unwrap_or(0));
            }
            Err(e) => eprintln!("Error: {}", e),
        }
    }
    
    // 3. 创建Issue
    async fn create_issue(client: &Client) {
        let owner = "your-username";
        let repo = "your-repo";
        
        let issue = IssuesCreateRequest {
            title: "Test issue".to_string(),
            body: Some("This is a test issue created with octorust".to_string()),
            assignee: None,
            assignees: None,
            milestone: None,
            labels: None,
        };
        
        match client.issues().create(owner, repo, &issue).await {
            Ok(created_issue) => {
                println!("Created issue #{}: {}", created_issue.number, created_issue.title);
            }
            Err(e) => eprintln!("Error creating issue: {}", e),
        }
    }
    
    // 4. 获取用户信息
    async fn get_user_info(client: &Client, username: &str) {
        match client.users().get_by_username(username).await {
            Ok(user) => {
                println!("User: {}", user.login);
                println!("Name: {:?}", user.name);
                println!("Public repos: {}", user.public_repos.unwrap_or(0));
            }
            Err(e) => eprintln!("Error: {}", e),
        }
    }
    
    // 5. 检查速率限制
    async fn check_rate_limit(client: &Client) {
        match client.rate_limit().get().await {
            Ok(rate_limit) => {
                println!("Remaining requests: {}", rate_limit.resources.core.remaining);
                println!("Reset time: {}", rate_limit.resources.core.reset);
            }
            Err(e) => eprintln!("Error: {}", e),
        }
    }
    
    // 执行示例函数
    get_repo_info(&client).await;
    get_user_info(&client, "octocat").await;
    check_rate_limit(&client).await;
    // create_issue(&client).await; // 取消注释来创建issue
}

注意事项

1. 确保正确处理GitHub API的速率限制
2. 对于生产环境，考虑实现请求重试逻辑
3. 敏感信息如token应该妥善管理，不要硬编码在代码中
4. 检查GitHub API文档了解各端点的权限要求

octorust提供了强大的GitHub API集成能力，通过类型安全的接口简化了开发流程，是Rust项目中与GitHub交互的理想选择。