# OpenApiDemo

**Repository Path**: ccae-sdk/openapidemo

## Basic Information

- **Project Name**: OpenApiDemo
- **Description**: 介绍如何搭建一个北向OSS的简易工程，实现调用CCAE的Rest client北向接口，快速上手搭建一个属于自己的CCAE北向数字地图“Hello World”。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2025-05-07
- **Last Updated**: 2025-05-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: CCAE, 北向接口, restclient

## README

# OpenApiDemo使用说明书

### 简介：

本文将介绍如何搭建一个RESTful客户端并使用它来调用CCAE系统的OpenAPI接口。

### 运行环境：

```
1、运行条件 Java 1.8
```

### 项目下载：

```
git clone https://gitee.com/ccae-sdk/openapidemo.git
```

### 环境准备：

1、在CCAE业务面主菜单中选择“系统 > 安全管理 > 用户管理”。在左侧导航树中选择“用户”，单击 “创建” 。

2、选择 “三方系统接入”，并输入需要创建的账号密码。

3、单击 “下一步” ， 勾选 “北向用户组”， 并单击 “下一步”。

4、单击 “完成”，完成账号创建。

### 运行前准备:

1、配置环境信息，对resource -> open_api_config ->northbound_setting.json进行修改。

```
{
  "nbiUserInfo": {
    "grantType": "password",
    "userName": "test_nb", 	//环境准备章节创建的用户名
    "value": "*******"  	//环境准备章节创建的用户密码
  },
  "nbiServerInfo": {
    "ip": "*.*.*.*", 		//环境准备章节中环境的IP地址
    "port": "26335"			//环境端口，一般不会变更
  }
}
```

2、设置需要调用的接口，对 src -> main -> com -> example -> constant -> RestConst.java进行修改， 本demo中已预制了业务拓扑接口URL信息，无需修改即可使用。

```
参数解释：
DEMO_URI 			//需要调用的URL地址
NBI_SESSION_URI		//获取系统session的接口
```

更多接口URL可参考：

登录环境后，在主菜单中选择“系统 > 系统设置 > 北向接口”。在左侧导航树中选择“API网关 > API列表”。

3、设置业务拓扑接口调用参数，对resource -> open_api_config ->demo_request_body.json进行修改。

```json
{
  "category": "server",
  "idType": "sn",
  "relationLayers": 2,
  "resources": [
    {
      "id": "61f44646f"		// 服务器序列号信息，可通过进入“资源 > 计算 > 服务器”页面查看关联的序列号信息列表
    }
  ]
}
```

注：不同接口参数差异较大，需要根据实际调用接口进行设置。

### 运行项目：

1、引入Maven依赖。

2、运行OpenApiDemo.java。

### 运行效果：

程序成功执行后会自动生成拓扑关系表，路径为src > main > output.html。

可以通过右击该HTML文件，选择 Open In >  Bowser > Built-in Preview 在Idea中查看拓扑关系。

![img](./image/acf681fc831558348172db221c1366dd_2527x988.png)

控制台显示接口原始返回的JSON结构。

![img](./image/9aa6afa3a892584ab67029c459a496c7_2559x1334.png)