# pbideaApiTestDemo

**Repository Path**: xiezhr/pbidea-api-test-demo

## Basic Information

- **Project Name**: pbideaApiTestDemo
- **Description**: 为Pbidea guide 文档提供测试服务
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-12-09
- **Last Updated**: 2025-08-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <img alt="logo" width="200px" src="imgs/logo.png">
</p>
<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;"> pbideaApiTestDemo</h1>
<h4 align="center">为pbideaguide文档提供测试服务</h4>
<p align="center">
  <a href="https://gitee.com/xiezhr/image-learn-bed/raw/master/image/wx.jpg"><img src="https://img.shields.io/badge/weChat-%E5%BE%AE%E4%BF%A1%E5%8F%B7-green.svg" alt="微信"></a>
  <a href="https://gitee.com/xiezhr/image-learn-bed/raw/master/image/微信公众号.png"><img src="https://img.shields.io/badge/%E5%85%AC%E4%BC%97%E5%8F%B7-程序员晓凡-blue.svg" alt="公众号"></a>
  <a href="https://www.xiezhrspace.cn"><img src="https://img.shields.io/badge/%E4%B8%AA%E4%BA%BA%E5%8D%9A%E5%AE%A2-www.xiezhrspace.cn-orange.svg" alt="个人博客"></a>
  <a href="https://blog.csdn.net/rong09_13"><img src="https://img.shields.io/badge/csdn-CSDN-red.svg" alt="cndn"></a>
   <a href="https://www.zhihu.com/people/rong-xie-49-35/posts"><img              src="https://img.shields.io/badge/zhihu-%E7%9F%A5%E4%B9%8E-blue.svg" alt="知乎"></a>
  <a href="https://juejin.im/user/1829211147871415"><img src="https://img.shields.io/badge/juejin-%E6%8E%98%E9%87%91-9cf.svg" alt="掘金"></a>
  <a href="https://space.bilibili.com/305330347"><img src="https://img.shields.io/badge/bilibili-%E5%93%94%E5%93%A9%E5%93%94%E5%93%A9-critical.svg" alt="哔哩哔哩"></a> 
</p>


-----

如果项目您有所帮助，记得 Star ⭐关注哦，这对我是晓凡非常不错的鼓励与支持。

别只点赞收藏哦，收藏≠学会，赶紧动起手敲起来吧。

重新开始最好的时间就是现在 *★,°*:.☆(￣▽￣)/$:*.°★* 。

--------



### 🍉一、项目简介

项目主要为`PBideaGuide` 文档中涉及到的接口调用提供服务。项目包含`get`、`post`、`web servise`等接口供pbidea测试使用。

### 🍊二、RESTful 接口

#### 🍓2.1 获取所有学生信息

##### 	2.1.1 基本信息

> 请求路径：/api/students
>
> 请求方式：GET
>
> 接口描述：该接口用于获取所有学生信息

##### 2.1.2 请求参数

无

##### 2.1.3 响应数据

响应数据类型：application/json

响应参数说明：

| 名称    | 类型   | 是否必须 | 默认值 | 备注                      | 其他信息 |
| ------- | ------ | -------- | ------ | ------------------------- | -------- |
| code    | number | 必须     |        | 响应码，200成功，其他失败 |          |
| message | string | 非必填   |        | 提示信息                  |          |
| data    | object | 必须     |        | 返回的数据                |          |

响应数据样例：

```json
{
  "code": 200,
  "message": "获取学生信息成功",
  "data": [
    {
      "id": "S001",
      "name": "晓凡",
      "age": 18,
      "gender": "男",
      "major": "计算机科学",
      "email": "xiezhr@qq.com",
      "phoneNumber": "13800000001"
    },
    {
      "id": "S002",
      "name": "李四",
      "age": 20,
      "gender": "女",
      "major": "电子工程",
      "email": "lisi@example.com",
      "phoneNumber": "13800000002"
    }
  ]
}

```

#### 🍓2.2 根据学生ID获取学生信息

##### 2.2.1 基本信息

> 请求路径：/api//students/id/id值
>
> 请求方式：GET
>
> 接口描述：该接口用于根据学生ID获取学生信息

##### 2.2.2 请求参数

| 参数名称 | 说明 | 类型    | 是否必须 | 备注   |
| -------- | ---- | ------- | -------- | ------ |
| id       |      | Integer | 是       | 学生id |

请求数据样例：

```url
http://localhost:8080/api/students/id/S001
```

##### 2.2.3 响应数据

响应数据类型：application/json

响应参数说明：

| 名称    | 类型   | 是否必须 | 默认值 | 备注                      | 其他信息 |
| ------- | ------ | -------- | ------ | ------------------------- | -------- |
| code    | number | 必须     |        | 响应码，200成功，其他失败 |          |
| message | string | 非必填   |        | 提示信息                  |          |
| data    | object | 必须     |        | 返回的数据                |          |

响应数据样例：

```json
{
  "code": 200,
  "message": "获取学生信息成功",
  "data": {
    "id": "S001",
    "name": "晓凡",
    "age": 18,
    "gender": "男",
    "major": "计算机科学",
    "email": "xiezhr@qq.com",
    "phoneNumber": "13800000001"
  }
}
```

#### 🍓2.3 添加学生信息

##### 2.3.1 基本信息

> 请求路径：/api/addstudent
>
> 请求方式：POST
>
> 接口描述：该接口用于添加学生信息

##### 2.3.2 请求参数

请求参数格式：application/json

请求参数说明:

| 参数名称    | 说明     | 类型   | 是否必须 | 备注 |
| ----------- | -------- | ------ | -------- | ---- |
| id          | 主键ID   | string | 是       |      |
| name        | 姓名     | string | 是       |      |
| age         | 年龄     | number | 是       |      |
| gender      | 性别     | string | 是       |      |
| major       | 专业     | string | 是       |      |
| email       | 邮箱     | string | 是       |      |
| phoneNumber | 电话号码 | string | 是       |      |

请求数据样例：

```json
{
    "id": "S006",
    "name": "小雅",
    "age": 18,
    "gender": "女",
    "major": "通信工程",
    "email": "xiaoya@qq.com",
    "phoneNumber": "13500000001"
}
```

##### 2.3.3 响应数据

响应数据类型：application/json

响应参数说明：

| 名称    | 类型   | 是否必须 | 默认值 | 备注                      | 其他信息 |
| ------- | ------ | -------- | ------ | ------------------------- | -------- |
| code    | number | 必须     |        | 响应码，201成功，其他失败 |          |
| message | string | 非必填   |        | 提示信息                  |          |
| data    | object | 必须     |        | 返回的数据                |          |

响应数据样例：

```json
{
    "code": 201,
    "message": "学生添加成功",
    "data": {
        "id": "S006",
        "name": "小雅",
        "age": 18,
        "gender": "女",
        "major": "通信工程",
        "email": "xiaoya@qq.com",
        "phoneNumber": "13500000001"
    }
}
```

#### 🍓2.4 获取用户信息

##### 2.4.1 基本信息

> 请求路径：/api/getUser
>
> 请求方式：GET
>
> 接口描述：该接口用于获取用户信息

##### 2.4.2 请求参数

请求参数格式：queryString

请求参数说明:

| 参数名称 | 说明 | 类型   | 是否必须 | 备注 |
| -------- | ---- | ------ | -------- | ---- |
| name     | 姓名 | string | 是       |      |
| sex      | 性别 | string | 是       |      |
| age      | 年龄 | string | 是       |      |

请求数据样例：

```url
http://localhost:8080/api/getUser?name=%E6%99%93%E5%87%A1&sex=%E7%94%B7&age=18
```



##### 2.4.3 响应数据

响应数据类型：application/json

响应参数说明：

| 名称    | 类型   | 是否必须 | 默认值 | 备注                      | 其他信息 |
| ------- | ------ | -------- | ------ | ------------------------- | -------- |
| code    | number | 必须     |        | 响应码，201成功，其他失败 |          |
| message | string | 非必填   |        | 提示信息                  |          |
| data    | object | 必须     |        | 返回的数据                |          |

响应数据样例：

```json
{
  "code": 200,
  "message": "获取学生信息成功",
  "data": {
    "sex": "男",
    "name": "晓凡",
    "age": 18
  }
}
```



### 🍋 三、web servise接口

#### 🍓3.1 获取学生信息

##### 3.1.1 基本信息

> 请求路径：/webservice/userService
>
> 请求方式：webservise
>
> 接口描述：该接口用于获取学生信息

wsdl地址：http://localhost:8080/webservice/userService?wsdl

```xml
<wsdl:definitions
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
    xmlns:tns="http://impl.webservise.pbideaapitestdemo.xiezhr.com/"
    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
    xmlns:ns2="http://schemas.xmlsoap.org/soap/http"
    xmlns:ns1="http://webservise.pbideaapitestdemo.xiezhr.com/" name="CodeServiseImplService" targetNamespace="http://impl.webservise.pbideaapitestdemo.xiezhr.com/">
    <script/>
    <wsdl:import location="http://localhost:8080/webservice/userService?wsdl=CodeServise.wsdl" namespace="http://webservise.pbideaapitestdemo.xiezhr.com/"></wsdl:import>
    <wsdl:binding name="CodeServiseImplServiceSoapBinding" type="ns1:CodeServise">
        <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
        <wsdl:operation name="getAllStudents">
            <soap:operation soapAction="" style="document"/>
            <wsdl:input name="getAllStudents">
                <soap:body use="literal"/>
            </wsdl:input>
            <wsdl:output name="getAllStudentsResponse">
                <soap:body use="literal"/>
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
    <wsdl:service name="CodeServiseImplService">
        <wsdl:port binding="tns:CodeServiseImplServiceSoapBinding" name="CodeServiseImplPort">
            <soap:address location="http://localhost:8080/webservice/userService"/>
        </wsdl:port>
    </wsdl:service>
</wsdl:definitions>
```



![wsdl地址](./assets/image-20241209231935804.png)

##### 3.1.2 请求参数

无

##### 3.1.3 响应数据

响应数据类型：application/xml

响应数据样例：

```xml
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:getAllStudentsResponse xmlns:ns2="http://webservise.pbideaapitestdemo.xiezhr.com/">
			<return>
				<age>18</age>
				<email>xiezhr@qq.com</email>
				<gender>男</gender>
				<id>S001</id>
				<major>计算机科学</major>
				<name>晓凡</name>
				<phoneNumber>13800000001</phoneNumber>
			</return>
			<return>
				<age>20</age>
				<email>lisi@example.com</email>
				<gender>女</gender>
				<id>S002</id>
				<major>电子工程</major>
				<name>李四</name>
				<phoneNumber>13800000002</phoneNumber>
			</return>
			<return>
				<age>19</age>
				<email>wangwu@example.com</email>
				<gender>男</gender>
				<id>S003</id>
				<major>机械工程</major>
				<name>王五</name>
				<phoneNumber>13800000003</phoneNumber>
			</return>
			<return>
				<age>19</age>
				<email>zhangsan@example.com</email>
				<gender>男</gender>
				<id>S004</id>
				<major>机械工程</major>
				<name>张三</name>
				<phoneNumber>13800000003</phoneNumber>
			</return>
		</ns2:getAllStudentsResponse>
	</soap:Body>
</soap:Envelope>

```



###  🍅 未来计划

用到新的服务将继续添加。。。。