API 接口文档：删除小区
一、接口名称
删除小区
二、接口描述
该接口用于删除指定的小区信息，主要提供给外部系统调用。
三、接口路径
http://{ip}:{port}/app/community.deleteCommunity
四、请求方法
POST
五、请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
Authorization |
是 | String |
用户认证 Token，通过登录接口获取 |
app-id |
是 | String |
应用 ID，由系统分配 |
transaction-id |
是 | String |
请求流水号，格式：1000000000+YYYYMMDDhhmmss+6位序列 |
sign |
是 | String |
签名，用于请求校验 |
req-time |
是 | String |
请求时间，格式：YYYYMMDDhhmmss |
六、请求参数
6.1 请求体（JSON）
| 参数名称 | 必填 | 类型 | 描述 | 示例 |
|---|---|---|---|---|
communityId |
是 | String |
小区唯一标识 | "2022092293190329" |
示例请求体：
{
"communityId": "2022092293190329"
}
七、返回值
7.1 返回格式（JSON）
| 参数名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
code |
int |
返回码，0 表示成功，其他表示失败 |
0 |
msg |
String |
返回信息 | "成功" |
示例返回：
{
"code": 0,
"msg": "成功"
}
八、错误码
| 错误码 | 描述 | 可能原因 |
|---|---|---|
0 |
成功 | 操作成功 |
非0 |
失败 | 参数错误、小区不存在、数据库操作失败等 |
九、业务逻辑说明
- 参数校验：检查
communityId是否为空。 - 查询小区：验证小区是否存在，如果不存在则返回错误。
- 删除小区：调用
communityV1InnerServiceSMOImpl.deleteCommunity执行删除操作。 - 返回结果：如果删除成功，返回
code=0；否则抛出异常。
十、示例请求
curl -X POST \
http://127.0.0.1:8080/app/community.deleteCommunity \
-H 'Authorization: Bearer xxxxxx' \
-H 'app-id: micro-community' \
-H 'transaction-id: 100000000020231010123456000001' \
-H 'req-time: 20231010123456' \
-H 'sign: xxxxxx' \
-d '{"communityId": "2022092293190329"}'
十一、示例响应
{
"code": 0,
"msg": "成功"
}
备注
- 必填参数：
communityId必须提供，否则请求会被拒绝。 - 事务支持：该接口使用
@Java110Transactional注解，确保数据库操作的原子性。 - 开发环境校验：在开发模式下（
Environment.isDevEnv()），会进行额外的参数校验。
维护信息
- 作者：吴学文
- 最后更新时间：2023-10-10
- 开源地址：MicroCommunity