lzyd-message-api/docs/swagger/swagger.json

{
    "swagger": "2.0",
    "info": {
        "contact": {},
        "license": {}
    },
    "paths": {
        "/api/chatroom/classification": {
            "get": {
                "description": "房间分类列表",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "房间操作"
                ],
                "summary": "房间分类列表",
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/api/chatroom/detail": {
            "get": {
                "description": "获取房间详情",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "房间操作"
                ],
                "summary": "获取房间详情",
                "parameters": [
                    {
                        "type": "string",
                        "description": "房间id",
                        "name": "room_id",
                        "in": "query",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/api/chatroom/join": {
            "post": {
                "description": "加入房间",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "房间管理"
                ],
                "summary": "加入房间",
                "parameters": [
                    {
                        "description": "加入房间请求body",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "type": "object",
                            "$ref": "#/definitions/models.JoinChatroomParam"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/api/chatroom/leave": {
            "post": {
                "description": "离开房间",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "房间管理"
                ],
                "summary": "离开房间",
                "parameters": [
                    {
                        "description": "离开房间请求body",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "type": "object",
                            "$ref": "#/definitions/models.LeaveChatroomParam"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/api/chatroom/list": {
            "post": {
                "description": "房间列表",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "房间操作"
                ],
                "summary": "房间列表",
                "parameters": [
                    {
                        "description": "房间请求列表body",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "type": "object",
                            "$ref": "#/definitions/models.ChatRoomListReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/api/chatroom/view": {
            "get": {
                "description": "进入直播间",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "房间操作"
                ],
                "summary": "进入直播间",
                "parameters": [
                    {
                        "type": "string",
                        "description": "房间id",
                        "name": "room_id",
                        "in": "query",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/api/graphic/list": {
            "get": {
                "description": "图文列表",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "直播间图文"
                ],
                "summary": "图文列表",
                "parameters": [
                    {
                        "type": "string",
                        "description": "房间id",
                        "name": "room_id",
                        "in": "query",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/api/message/send": {
            "post": {
                "description": "发送消息",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "消息管理"
                ],
                "summary": "发送消息",
                "parameters": [
                    {
                        "description": "发送请求body",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "type": "object",
                            "$ref": "#/definitions/models.MessageParam"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/api/message/timeline": {
            "get": {
                "description": "获取历史消息记录",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "消息管理"
                ],
                "summary": "获取历史消息记录",
                "parameters": [
                    {
                        "type": "string",
                        "description": "用户id",
                        "name": "userId",
                        "in": "query"
                    },
                    {
                        "type": "string",
                        "description": "房间id",
                        "name": "roomId",
                        "in": "query",
                        "required": true
                    },
                    {
                        "type": "integer",
                        "description": "当前页",
                        "name": "pageIndex",
                        "in": "query",
                        "required": true
                    },
                    {
                        "type": "integer",
                        "description": "每页数量",
                        "name": "pageSize",
                        "in": "query",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\", \"data\":{}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/api/wx/share": {
            "get": {
                "description": "微信自定义分享",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "用户操作"
                ],
                "summary": "分享",
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/wx/h5/login": {
            "get": {
                "description": "登录",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "用户操作"
                ],
                "summary": "登录",
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "models.ChatRoomListReq": {
            "type": "object",
            "properties": {
                "category": {
                    "type": "string"
                },
                "name": {
                    "type": "string"
                },
                "page": {
                    "type": "integer"
                },
                "pageSize": {
                    "type": "integer"
                }
            }
        },
        "models.JoinChatroomParam": {
            "type": "object",
            "properties": {
                "roomId": {
                    "type": "string"
                },
                "userId": {
                    "type": "string"
                }
            }
        },
        "models.LeaveChatroomParam": {
            "type": "object",
            "properties": {
                "roomId": {
                    "type": "string"
                },
                "userId": {
                    "type": "string"
                }
            }
        },
        "models.MessageParam": {
            "type": "object",
            "properties": {
                "message": {
                    "type": "string"
                },
                "messageType": {
                    "type": "string"
                },
                "roomId": {
                    "type": "string"
                },
                "userId": {
                    "type": "string"
                }
            }
        }
    }
}