Swagger基本示例

最新推荐文章于 2022-08-17 17:52:51 发布

ITKEY_

最新推荐文章于 2022-08-17 17:52:51 发布

阅读量809

点赞数

分类专栏： java 文章标签： java intellij-idea

本文链接：https://blog.csdn.net/lxyoucan/article/details/124804951

版权

java 专栏收录该内容

148 篇文章 6 订阅

订阅专栏

本文档详细介绍了融云用户接口中创建群组的方法，包括RESTful API的使用，以及Swagger接口注解的编写。该接口需要提供用户ID、群组ID、群组名称等参数，可选地设置群头像和群简介。创建群组的方法实现了群组的创建功能，并返回操作结果。

摘要由CSDN通过智能技术生成

类注解

@RestController
@RequestMapping("/im/wsdm/user")
@Api(tags = "融云用户")
public class ImWsdmUserController extends BaseController {

方法注解

后端Swagger 接口文档注解编写示例：
    /**
     * 创建群组方法
     * API 文档: http://www.rongcloud.cn/docs/server_sdk_api/group/group.html#create*
     *
     * @param userId            [必填] 要加入群的用户 Id，最多不超过 1000 个。
     * @param groupId           [必填] 创建群组 Id，支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 64 字节。
     * @param groupName         [必填] 群组 Id 对应的名称，用于在发送群组消息显示远程 Push
     *                          通知时使用，如群组名称改变需要调用刷新群组信息接口同步。
     * @param groupPortrait     [可选] 群头像
     * @param groupIntroduction [可选] 群简介
     */
    @ApiOperation(value = "创建群组方法", notes = "API 文档: http://www.rongcloud.cn/docs/server_sdk_api/group/group.html#create")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userId", value = " [必填] 要加入群的用户 Id，最多不超过 1000 个。", required = true, dataType = "String"),
            @ApiImplicitParam(name = "groupId", value = " [必填] 创建群组 Id，支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 64 字节。", required = true, dataType = "String"),
            @ApiImplicitParam(name = "groupName", value = "[必填] 群组 Id 对应的名称，用于在发送群组消息显示远程 Push通知时使用，如群组名称改变需要调用刷新群组信息接口同步。", required = true, dataType = "String"),
            @ApiImplicitParam(name = "groupPortrait", value = "[可选] 群头像", required = false, dataType = "String"),
            @ApiImplicitParam(name = "groupIntroduction", value = "[可选] 群简介", required = false, dataType = "String"),
    })
    @RequestMapping("/create")
    public AjaxResult create(String userId, String groupId, String groupName, String groupPortrait, String groupIntroduction) {
        return imWsdmGroupService.create(userId, groupId, groupName, groupPortrait, groupIntroduction);
    }