openeuler/mcp开发者必备：API接口使用与服务扩展教程

openeuler/mcp开发者必备：API接口使用与服务扩展教程

【免费下载链接】mcpMulti-cloud management platform backend project项目地址: https://gitcode.com/openeuler/mcp

前往项目官网免费下载：https://ar.openeuler.org/ar/

openEuler/mcp是一款多云管理平台后端项目（Multi-cloud management platform backend project），为开发者提供了丰富的API接口和灵活的服务扩展能力。本文将详细介绍如何高效使用其API接口及进行服务扩展，帮助开发者快速上手。

一、API接口概览：核心功能与调用方式 🚀

openeuler/mcp的API接口采用RESTful设计风格，主要集中在mcp-cloud-manage模块的控制器（Ctrl）层。通过@RestController和@RequestMapping注解定义接口路径，支持POST等请求方式。

1.1 主要API模块及路径

• VDC管理：/api/vdc，提供创建、修改、查询VDC等接口，如@PostMapping("/createVdc")（VdcCtrl.java）。
• 集群管理：/api/cluster，包含集群创建、登录、详情查询等功能，例如@PostMapping("/creatCluster")（ClusterCtrl.java）。
• 用户管理：/api/user，提供用户信息查询、密码重置、用户创建等接口，如@PostMapping("/createUser")（UserCtrl.java）。
• 高可用管理：/api/ha，涉及主从节点管理，如@PostMapping("/addSlave")添加从节点（KcpHaCtrl.java）。

1.2 接口调用示例

以创建VDC为例，接口路径为/api/vdc/createVdc，请求参数需包含VDC名称、资源配置等信息，具体可参考实体类CreateVdcParam（CreateVdcParam.java）。

二、服务扩展指南：从接口到实现 🔧

openeuler/mcp采用分层架构，服务扩展主要涉及接口定义、实现类编写和依赖注入三个步骤。

2.1 定义服务接口

在mcp-cloud-core模块的service目录下定义接口，继承IService以获得基本CRUD能力。例如：

public interface CloudVdcCpuService extends IService<CloudVdcCpuDo> { // 自定义方法 }

（CloudVdcCpuService.java）

2.2 实现服务逻辑

在service/impl目录下编写实现类，使用@Service注解注入Spring容器。例如：

@Service public class CloudVdcCpuServiceImpl extends ServiceImpl<CloudVdcCpuMapper, CloudVdcCpuDo> implements CloudVdcCpuService { // 实现接口方法 }

（CloudVdcCpuServiceImpl.java）

2.3 控制器层对接

在mcp-cloud-manage的ctrl目录中添加接口，通过@Autowired注入服务。例如：

@RestController @RequestMapping("/api/vdc") public class VdcCtrl { @Autowired private CloudVdcService cloudVdcService; @PostMapping("/createVdc") public MCResponseData createVdc(@RequestBody CreateVdcParam param) { return cloudVdcService.createVdc(param); } }

（VdcCtrl.java）

三、开发必备工具与最佳实践 ✨

3.1 项目结构速览

核心模块说明：

• mcp-cloud-core：包含基础服务接口、数据模型（domain）及工具类（common）。
• mcp-cloud-manage：提供管理端API接口（ctrl）和业务逻辑实现。
• mcp-self-service：面向自服务用户的接口和服务。

3.2 接口调试与测试

建议使用Postman或curl调用API，例如创建区域接口：

curl -X POST http://localhost:8080/api/zone/createZone \ -H "Content-Type: application/json" \ -d '{"zoneName":"test-zone","description":"测试区域"}'

3.3 扩展注意事项

• 遵循依赖注入原则，避免硬编码服务实例。
• 新接口需添加到权限控制列表（参考PermissionCtrl.java）。
• 异常处理统一使用KylinException（KylinException.java）。

四、快速开始：环境搭建与依赖配置 📦

4.1 项目克隆

git clone https://gitcode.com/openeuler/mcp

4.2 核心依赖

项目基于Spring Boot开发，主要依赖包括：

• Spring Boot Starter Web
• MyBatis-Plus（数据访问）
• Redis（缓存）
• 具体版本见根目录pom.xml

总结

openeuler/mcp通过清晰的API设计和模块化架构，为多云管理平台开发提供了强大支持。开发者可通过本文介绍的接口调用方式和服务扩展步骤，快速实现功能定制。更多详细文档可参考项目源码中的注释及模块说明。

【免费下载链接】mcpMulti-cloud management platform backend project项目地址: https://gitcode.com/openeuler/mcp