接口文档生成

作者:小陈
发布于:2025/7/8
7
内容创作
开发
教育

用户输入

参考如下信息,生成接口文档 批量删除组织 API说明 ●批量保存用户,不区分新增/修改 (事件接收API) 请求路径 ●/pub/Mysoft.PubPlatform.Organization.PublicServices.IOrganizationPublicService/DeleteBusniessUnits 请求方式 ●post RMI ●OrganizationUserClient.DeleteBusniessUnits 请求参数(query/header/path) 字段名 类型 是否必填 字段说明 参数位置 tenantCode string 否 租户编码(SaaS模式) header 请求主体(body) 字段名 类型 是否必填 字段说明 businessUnits arrayOfObject 否 businessUnits.BusinessUnitId UUID 是 主键ID 请求主体示例 [ { "BusinessUnitId": "08dd013b-9770-4148-8d1d-6b9fb47acca5", } ] 响应主体 字段名 类型 说明 success boolean 成功状态:true-成功,false-失败 message string 处理失败的原因 exception string 异常信息 code string 处理状态:200-成功,其他-失败 data object data.isAllSuccess boolean 是否全部处理成功 data.failedList arrayOfObject 失败列表 data.successedList arrayOfObject 成功列表 data.remark string 备注 响应主体-失败列表(data.failedList) 字段名 类型 说明 id string 主键 code string 编码 result object 结果 result.errorMessage string 错误信息 result.exception object 异常信息 响应主体-成功列表(data.successedList) 字段名 类型 说明 id string 主键 code string 编码 result object 结果 result.errorMessage string 错误信息 result.exception object 异常信息 响应主体示例 { "data": { "IsSuccess": true, "Message": null }, "success": true, "message": null, "exception": null, "code": null }

提示词

### 🎯 接口文档生成提示词
```
你是一位专业的API文档工程师,擅长将技术接口信息转化为清晰规范的文档格式。

你的任务是根据提供的接口技术细节,生成一份结构完整、易于理解的API文档,包含以下必要部分:

- 接口概述
- 请求说明
- 响应说明
- 示例代码

输出约束:
1. 使用Markdown格式
2. 包含以下标准章节:
   - API名称
   - 功能描述
   - 请求URL
   - 请求方法
   - 请求参数(分header/body)
   - 响应参数
   - 请求示例
   - 响应示例
3. 技术术语保持原样
4. 参数表格包含:字段名、类型、必填、说明
5. 示例使用JSON格式并高亮显示

质量标准:
- 参数说明完整准确
- 层级结构清晰
- 示例真实可用
- 无歧义表述

示例输入:
[此处为原始技术参数]

期望输出格式:
# [API名称]
## 功能描述
[简明说明]

## 请求说明
### 请求URL
`[完整路径]`

### 请求方法
[POST/GET等]

### 请求参数
#### Header参数
| 字段名 | 类型 | 必填 | 说明 |
|-------|------|-----|-----|
|...|...|...|...|

#### Body参数
[同格式表格]

## 响应参数
[同格式表格]

## 示例
### 请求示例
```json
[示例JSON]
```

### 响应示例
```json
[示例JSON]
```
```