web socket

11人阅读 评论(0) 收藏 举报
分类:

《预售演示系统接口文档》

==========================================================================

一、请求接口列表

  • 0、响应模板

    注意:以下的所有接口的返回值都是指定响应的data数据项

响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
message 错误信息 string 在出现错误的时候的错误信息
data 返回的数据 object 这个是返回的数据,可能是对象,也可能是集合,是接口而定
  • 1.1、房间类型添加接口

    请求方法:POST

    请求url:
    /housetype/roomtype














    请求参数 参数含义 参数类型 参数备注
    name 房间类型名称 string
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 1.2、房间类型删除接口

    请求方法:DELETE

    请求url:
    /housetype/roomtype/{id}














    请求参数 参数含义 参数类型 参数备注
    id 房间类型的ID number
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 1.3、房间类型修改接口

    请求方法:PUT

    请求url:
    /housetype/roomtype/{id}




















    请求参数 参数含义 参数类型 参数备注
    id 房间类型的ID number
    name 新的房间类型的名称 string
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 1.4、获取全部房间类型接口

    请求方法:GET

    请求url:
    /housetype/roomtype








    请求参数 参数含义 参数类型 参数备注
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
message 错误信息 string 在出现错误的时候的错误信息
data 所有的房间类型 List<RoomType>
  • 2.1、房间类型添加接口

    请求方法:POST

    请求url:
    /housetype














    请求参数 参数含义 参数类型 参数备注
    name 户型名称 string
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 2.2、户型删除接口

    请求方法:DELETE

    请求url:
    /housetype/{id}














    请求参数 参数含义 参数类型 参数备注
    id 户型的ID number
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 2.3、户型名称修改接口

    请求方法:PUT

    请求url:
    /housetype/{id}




















    请求参数 参数含义 参数类型 参数备注
    id 户型的ID number
    name 新的户型的名称 string
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 2.4、获取全部户型接口

    请求方法:GET

    请求url:
    /housetype








    请求参数 参数含义 参数类型 参数备注
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
message 错误信息 string 在出现错误的时候的错误信息
data 所有的房间类型 List<HouseType> HouseType包含HouseTypeImage,包含房间类型
  • 2.5、获取指定户型接口

    请求方法:GET

    请求url:
    /housetype/{id}














    请求参数 参数含义 参数类型 参数备注
    id 户型的id number
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
message 错误信息 string 在出现错误的时候的错误信息
data 指定房间类型 HouseType HouseType包含HouseTypeImage,包含房间类型
  • 3.1、户型图片添加接口

    请求方法:POST

    请求url:
    /image/housetype
































    请求参数 参数含义 参数类型 参数备注
    houseTypeId 户型的ID number
    roomTypeId 房间类型的ID number
    imageType 图片的分类 number 图片的分类:1.样板间图片,2.3D图片,3.户型的平面图
    file 文件属性的属性名称 string 用于后台接收上传文件
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 3.2、户型图片删除接口

    请求方法:DELETE

    请求url:
    /image/housetype/{id}
































    请求参数 参数含义 参数类型 参数备注
    houseTypeId 户型的ID number
    roomTypeId 房间类型的ID number
    imageType 图片的分类 number 图片的分类:1.样板间图片,2.3D图片,3.户型的平面图
    id 户型图片的ID number
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 3.3、户型图片修改接口

    请求方法:PUT

    请求url:
    /image/housetype/{id}






































    请求参数 参数含义 参数类型 参数备注
    houseTypeId 户型的ID number
    roomTypeId 房间类型的ID number
    imageType 图片的分类 number 图片的分类:1.样板间图片,2.3D图片,3.户型的平面图
    id 户型图片的ID number
    file 文件属性的属性名称 string 新的文件
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 4.1、获取全部一级菜单

    请求方法:GET

    请求url:
    /module/main








    请求参数 参数含义 参数类型 参数备注
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
message 错误信息 string 在出现错误的时候的错误信息
data 一级菜单列表 Lst<ModuleBar>
  • 4.2、获取指定一级菜单的二级菜单

    请求方法:GET

    请求url:
    /module/second/{id}














    请求参数 参数含义 参数类型 参数备注
    id 父级菜单的菜单ID number
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
message 错误信息 string 在出现错误的时候的错误信息
data 指定的二级菜单列表 Lst<ModuleBar>
  • 4.3、获取激活的全部一级菜单

    请求方法:GET

    请求url:
    /module/enable/main








    请求参数 参数含义 参数类型 参数备注
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
message 错误信息 string 在出现错误的时候的错误信息
data 一级菜单列表 Lst<ModuleBar>
  • 4.4、获取激活的指定一级菜单的二级菜单

    请求方法:GET

    请求url:
    /module/enable/second/{id}














    请求参数 参数含义 参数类型 参数备注
    id 父级菜单的菜单ID number
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
message 错误信息 string 在出现错误的时候的错误信息
data 指定的二级菜单列表 Lst<ModuleBar>
  • 4.5、设置菜单是否启用的接口

    请求方法:PUT

    请求url:
    /module/enable/{id}




















    请求参数 参数含义 参数类型 参数备注
    id 菜单的id number 无论是一级菜单还是二级菜单
    enable 是否启用 boolean true 表示启用,false表示关闭
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 4.6、修改菜单名称的接口

    请求方法:PUT

    请求url:
    /module/name/{id}




















    请求参数 参数含义 参数类型 参数备注
    id 菜单的id number 无论是一级菜单还是二级菜单
    name 菜单的名称 boolean true 表示启用,false表示关闭
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 5.1、项目logo添加接口

    请求方法:POST

    请求url:
    /projectlogo














    请求参数 参数含义 参数类型 参数备注
    file 文件属性的属性名称 string 用于后台接收上传文件
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 5.2、项目logo删除接口

    请求方法:DELETE

    请求url:
    /projectlogo








    请求参数 参数含义 参数类型 参数备注
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
  • 5.3、项目logo获取接口

    请求方法:GET

    请求url:
    /projectlogo








    请求参数 参数含义 参数类型 参数备注
响应参数 参数含义 参数类型 参数备注
statue 状态码 number 1 表示成功,0 表示失败
message 错误信息 string 在出现错误的时候的错误信息
data 项目 ProjectLogo

二、对象字段列表

  • 1、图片对象:Image

    对象描述:图片的对象结构

    字段名称 字段类型 字段备注
    imageId number 图片的唯一ID,作为图片修改和删除的依据
    imageLocation string 图片的位置,是一个相对位置
  • 2、文本对象:Text

    对象描述:多条文本对象的文本记录对象

    字段名称 字段类型 字段备注
    id number 用于多条文本修改的ID依据
    content string 文本的内容
  • 3、主页对象:MainPage

    对象描述:记录主页的信息

    字段名称 字段类型 字段备注
    id number 主页数据的ID,但是只有一条记录
    backgroundImage Image 背景图片
    projectImage Image 项目的展示图片
  • 4、项目logo对象:ProjectLogo

    对象描述:记录项目的logo图片位置信息

    字段名称 字段类型 字段备注
    id number 项目logo数据的ID,但是只有一条记录
    projectLogoImage Image 项目的logo图片
  • 5、房间类型对象:RoomType

    对象描述:记录房间分类信息

    字段名称 字段类型 字段备注
    id number 房间类型数据的ID
    name string 房间类型的名称,譬如厨房
  • 6、户型的图片分类对象:HouseTypeImage

    对象描述:同一个户型的样板间、平面图的分类数据

    字段名称 字段类型 字段备注
    id number
    roomType RoomType 房间类型的名称,譬如厨房
    image Image 具体对应的图片信息
  • 7、户型数据对象:HouseType

    对象描述:一个户型一条数据

    字段名称 字段类型 字段备注
    id number
    name string 户型的名称,譬如精装户型什么的
    housePlans List<HouseTypeImage> 该户型所对应的所有平面图图片集合
    houseSampleRooms List<HouseTypeImage> 该户型所对应的所有样板间图片集合
    house3DMaps List<HouseTypeImage> 该户型所对应的所有3D图片集合
  • 8、功能菜单对象:ModuleBar

    对象描述:实现对菜单的分级管理

    字段名称 字段类型 字段备注
    id number
    description string 功能模块的名称
    url string 该功能模块所绑定的url链接
    enable boolean 标识该功能模块是否被选用
    parentId number 标识该菜单的父菜单,顶级菜单无父菜单,值为 0
    barLevel number 记录这个菜单是几级菜单,用于从父菜单进行页面跳转的时候进行子菜单查询用的
  • 9、企业文化数据对象:CompanyCulture

    对象描述:公司的文化

    字段名称 字段类型 字段备注
    id number
    title string 企业文化的标题
    content string 企业文化的内容
    image Image 企业文化的对应配图
  • 10、企业发展历程数据对象:CompanyDevelopHistory

    对象描述:公司的发展历程数据

    字段名称 字段类型 字段备注
    id number
    title string 发展历程的标题
    content string 发展历程的文字介绍
    image Image 每一个阶段的配图
    begin date 发展历程的开始时间
    end date 发展历程的结束时间
  • 11、企业荣誉数据对象:CompanyHonor

    对象描述:公司的荣誉数据

    字段名称 字段类型 字段备注
    id number
    contents List<Text> 荣誉的数据
    images List<Image> 企业荣誉的图片资料
  • 12、企业介绍数据对象:CompanyIntroduction

    对象描述:公司的简介

    字段名称 字段类型 字段备注
    id number
    introduction string 企业文字简介
    images List<Image> 企业简介的图片
  • 13、项目介绍数据对象:ProjectIntroduction

    对象描述:项目的简介

    字段名称 字段类型 字段备注
    id number
    introduction string 项目文字简介
    image Image 项目简介的图片
  • 14、项目周边图片信息数据对象:ProjectSurround

    对象描述:项目的周边配套

    字段名称 字段类型 字段备注
    id number
    landscapes List<Image> 项目的园林景观图片
    image Image 项目的周边设施配套
查看评论

spring使用web socket

  • 2018年04月09日 15:46
  • 27KB
  • 下载

【Socket编程】Python实现简易Web服务器

利用Python,我们可以搭建一个简单的Web服务器,这里我参考了: https://ruslanspivak.com/lsbaws-part1/...
  • woxiaohahaa
  • woxiaohahaa
  • 2017-09-10 18:19:56
  • 944

socket 请求Web服务器过程

HTTP协议只是一个应用层协议,它底层是通过TCP进行传输数据的。因此,浏览器访问Web服务器的过程必须先有“连接建立”的发生。 而有人或许会问:众所周知,HTTP协议有两大特性,一个是“无连接”性,...
  • zqixiao_09
  • zqixiao_09
  • 2016-01-24 21:41:41
  • 1889

基于Socket编程实现一个简单的Web服务器

using System; using System.Collections.Generic; using System.Linq; using System.Net; using System.Ne...
  • CGS_______
  • CGS_______
  • 2017-06-24 15:32:36
  • 895

web请求和socket通信

详谈socket请求Web服务器过程 最开始我们需要明白一件事情,因为这是这篇文章的前提: HTTP协议只是一个应用层协议,它底层是通过TCP进行传输数据的...
  • liu_qiqi
  • liu_qiqi
  • 2015-05-16 10:15:41
  • 4536

Java Socket搭建一个简单地Web服务器(1)

今天突然想写一个简单地Web服务器,根据我对Tomcat的了解,简单总结了一下写一个简单地服务器需要哪些步骤: 1.首先肯定要借助ServerSocket和Socket这两个类。 2.Server...
  • p744174529
  • p744174529
  • 2017-06-27 21:17:39
  • 335

C# Socket实现Http WEB服务器

WWW的工作基于客户机/服务器计算模型,由Web 浏览器(客户机)和Web服务器(服务器)构成,两者之间采用超文本传送协议(HTTP)进行通信,HTTP协议的作用原理包括四个步骤:连接,请求,应答。根...
  • gaozhigang
  • gaozhigang
  • 2008-07-03 11:16:00
  • 5717

ServerSocket实现 一个简单的Web服务器 [引]

深入剖析tomcat ch01 项目代码https://github.com/dzetJavaEE/tomcat_ch01项目结构请求结果HttpServer import java.io.File;...
  • qqduxingzhe
  • qqduxingzhe
  • 2017-12-08 17:12:47
  • 320

webservice中使用socket

做的一个基于jdk 使用webservice 发布的接口,项目中服务端是登陆修改密码等接口,当用户登录之后,服务端要判断客户端的状态是否在线。所以就使用了Socket 发送心跳包。中间开发过程中也出现...
  • zhupin0804
  • zhupin0804
  • 2017-09-08 17:25:19
  • 311

java web 项目启动开启 socket server 作者:Mchange

web.xml中配置监听 [html] view plaincopy    listener>     listener-class>com.a...
  • fanhenghui
  • fanhenghui
  • 2016-05-18 17:21:46
  • 2168
    个人资料
    等级:
    访问量: 338
    积分: 81
    排名: 152万+
    文章存档