Casdoor项目RESTful API接口详解
2025-07-06 04:39:15作者：魏献源Searcher
概述
Casdoor作为一个开源的统一身份认证平台，提供了丰富的RESTful API接口用于系统集成和管理。本文将深入解析Casdoor的API设计架构、核心功能接口以及使用方式，帮助开发者更好地理解和使用Casdoor的API能力。
API基础信息
Casdoor API遵循RESTful设计规范，当前版本为1.503.0，支持HTTP和HTTPS协议。API文档采用Swagger 2.0规范，提供了清晰的接口定义和参数说明。
核心API分类
1. OIDC相关API
Casdoor实现了标准的OpenID Connect协议，提供了以下关键端点：
/.well-known/openid-configuration：获取OIDC发现配置信息/.well-known/jwks：获取JWK公钥集合
这些接口使得Casdoor可以轻松集成到任何支持OIDC协议的系统中。
2. 认证回调API
/api/Callback接口处理认证后的回调请求，返回用户信息对象。这是OAuth/OIDC流程中的重要环节。
3. 资源管理API
Casdoor提供了完整的资源管理能力：
- 应用管理：
/api/add-application等接口用于应用CRUD - 组织管理：
/api/add-organization等接口管理组织结构 - 用户组管理：
/api/add-group接口管理用户分组
4. 权限控制API
权限系统是Casdoor的核心，相关API包括：
- 权限模型：
/api/add-model - 权限规则：
/api/add-permission - 执行器管理：
/api/add-enforcer
5. 扩展功能API
Casdoor还提供了丰富的扩展功能：
- LDAP集成：
/api/add-ldap - 支付系统：
/api/add-payment - 产品管理：
/api/add-product - 定价策略：
/api/add-pricing
典型API详解
添加应用接口示例
POST /api/add-application
{
"name": "myApp",
"displayName": "我的应用",
"logo": "https://example.com/logo.png",
"homepageUrl": "https://example.com"
}
响应示例：
{
"status": "ok",
"msg": "",
"data": {
"id": "app_123456"
}
}
添加用户组接口示例
POST /api/add-group
{
"name": "developers",
"displayName": "开发组",
"description": "软件开发团队"
}
最佳实践
- 认证方式：所有管理API都需要有效的访问令牌
- 错误处理：检查返回的Response对象中的status字段
- 批量操作：对于大量数据，建议分批次调用API
- 版本控制：注意API版本兼容性
总结
Casdoor的API设计遵循了RESTful最佳实践，提供了从基础认证到复杂权限管理的完整解决方案。通过合理使用这些API，开发者可以轻松实现：
- 统一身份认证系统集成
- 细粒度的权限控制
- 多租户支持
- 可扩展的用户管理体系
对于需要深度定制的场景，Casdoor的API也提供了足够的灵活性和扩展性。建议开发者根据实际需求，结合官方文档进行集成开发。
