Readme.md
@@ -92,7 +92,7 @@ 运维团队 账号/密码：admin/admin 开发团队 账号/密码：dev/(由于开发者权限较大，删除数据会影响稳定性，查看具体功能，可以单独部署查看) 开发团队 账号/密码：dev/(由于开发者权限较大，删除数据会影响稳定性，查看具体功能，可以单独部署在u_user 表中修改) ### 运行效果（view） 1.在浏览器输入 http://localhost:3000/ 如下图 docs/document/_sidebar.md
@@ -16,22 +16,16 @@ * [功能列表](func/funcation.md) * 二次开发 * 开发 * [前段开发](develop/front.md) * [接口开发](develop/api.md) * [服务端开发](develop/service.md) * [添加服务](develop/addService) * [用户权限校验](develop/checkPrivilege.md) * [硬件对接](develop/machine.md) * 字典数据 * Api开放接口 * [业务类型](dict/businessType.md) * [组件](dict/app.md) * api接口 * [用户类接口](api/user/index.md) * [用户注册](api/user/register.md) * [用户登录](api/user/login.md) * [游客登记](api/user/saveVisit.md) docs/document/api/user/checkLogin.md
File was deleted docs/document/api/user/index.md
New file @@ -0,0 +1,243 @@ ## 1.0 用户注册 ###### 接口功能 > 用户通过web端或APP注册用户接口 ###### URL > [http://api.java110.com:8008/api/user.service.register](http://api.java110.com:8008/api/user.service.register) ###### 支持格式 > JSON ###### HTTP请求方式 > POST ###### 请求参数(header部分) |参数名称|约束|类型|长度|描述|取值说明| | :-: | :-: | :-: | :-: | :-: | :-:| |app_id|1|String|30|应用ID|Api服务分配 | |transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 | |sign|1|String|-|签名|请参考签名说明| |req_time|1|String|-|请求时间|YYYYMMDDhhmmss| ###### 请求参数(body部分) |参数名称|约束|类型|长度|描述|取值说明| | :-: | :-: | :-: | :-: | :-: | :-: | |name|1|String|50|用户名称|-| |email|1|String|30|邮箱地址|邮箱地址1234@xx.com| |password|1|String|128|密码|加盐码md5| |tel|1|String|11|手机号|11位手机号| |sex|?|String|1|性别|0表示男孩 1表示女孩| ###### 返回协议 当http返回状态不为200 时请求处理失败 body内容为失败的原因 当http返回状态为200时请求处理成功，body内容为返回内容， |参数名称|约束|类型|长度|描述|取值说明| | :-: | :-: | :-: | :-: | :-: | :-:| |userId|1|String|30|用户名称|用户ID| |responseTime|?|String|16|时间|请求返回的时间| ###### 举例 > 地址：[http://api.java110.com:8008/api/user.service.register](http://api.java110.com:8008/api/user.service.register) ``` javascript 请求头信息： Content-Type:application/json USER_ID:1234 APP_ID:8000418002 TRANSACTION_ID:10029082726 REQ_TIME:20181113225612 SIGN:aabdncdhdbd878sbdudn898 请求报文： { "name": "张三", "email": "928255095@qq.com", "password": "ERCBHDUYFJDNDHDJDNDJDHDUDHDJDDKDK", "sex": "0", "tel": "17797173943" } 返回报文： {"responseTime":"20181125230634","userId":"30516389265349820416"} ``` ## 2.0 用户登录 ###### 接口功能 > 用户通过web端或APP登录系统 ###### URL > [http://api.java110.com:8008/api/user.service.login](http://api.java110.com:8008/api/user.service.login) ###### 支持格式 > JSON ###### HTTP请求方式 > POST ###### 请求参数(header部分) |参数名称|约束|类型|长度|描述|取值说明| | :-: | :-: | :-: | :-: | :-: | :-:| |app_id|1|String|30|应用ID|Api服务分配 | |transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 | |sign|1|String|-|签名|请参考签名说明| |req_time|1|String|-|请求时间|YYYYMMDDhhmmss| ###### 请求参数(body部分) |参数名称|约束|类型|长度|描述|取值说明| | :-: | :-: | :-: | :-: | :-: | :-: | |username|1|String|50|用户名|-| |passwd|1|String|30|密码|-| ###### 返回协议 当http返回状态不为200 时请求处理失败 body内容为失败的原因 当http返回状态为200时请求处理成功，body内容为返回内容， |参数名称|约束|类型|长度|描述|取值说明| | :-: | :-: | :-: | :-: | :-: | :-:| |userName|1|String|30|用户名称|用户名称| |userId|1|String|30|用户ID|用户ID| |token|?|String|64|鉴权码|鉴权码| ###### 举例 > 地址：[http://api.java110.com:8008/api/user.service.login](http://api.java110.com:8008/api/user.service.login) ``` javascript 请求头信息： Content-Type:application/json USER_ID:1234 APP_ID:8000418002 TRANSACTION_ID:10029082726 REQ_TIME:20181113225612 SIGN:aabdncdhdbd878sbdudn898 请求报文： { "username":"admin", "passwd":"d57167e07915c9428b1c3aae57003807" } 返回报文： {"userName":"admin","userId":"10001","token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqYXZhMTEwIiwianRpIjoiNmUzZGNjMzM3YmE4NGRmMTgxNzcwNDVjOTIzOTljOTAifQ.oUotKsoy1TXBS37isSvwKTQ9c_tTxZS48TA554QdbEU"} ``` ## 3.0 用户退出登录 ###### 接口功能 > 用户通过web端或APP退出系统 ###### URL > [http://api.java110.com:8008/api/user.service.logout](http://api.java110.com:8008/api/user.service.logout) ###### 支持格式 > JSON ###### HTTP请求方式 > POST ###### 请求参数(header部分) |参数名称|约束|类型|长度|描述|取值说明| | :-: | :-: | :-: | :-: | :-: | :-:| |app_id|1|String|30|应用ID|Api服务分配 | |transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 | |sign|1|String|-|签名|请参考签名说明| |req_time|1|String|-|请求时间|YYYYMMDDhhmmss| ###### 请求参数(body部分) |参数名称|约束|类型|长度|描述|取值说明| | :-: | :-: | :-: | :-: | :-: | :-: | |token|?|String|64|鉴权码|鉴权码| ###### 返回协议 当http返回状态不为200 时请求处理失败 body内容为失败的原因 当http返回状态为200时请求处理成功，body内容为返回内容， ###### 举例 > 地址：[http://api.java110.com:8008/api/user.service.logout](http://api.java110.com:8008/api/user.service.logout) ``` javascript 请求头信息： Content-Type:application/json USER_ID:1234 APP_ID:8000418002 TRANSACTION_ID:10029082726 REQ_TIME:20181113225612 SIGN:aabdncdhdbd878sbdudn898 请求报文： { "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqYXZhMTEwIiwianRpIjoiYWQ0ZjRjODUyZjI4NGY0Yjk4ODQzZDE3MmI4MmNmYTYifQ.p0KrdYX3-bifZ036WYCoyFQjoAo5_7bY1NXTwwOHPuk" } 返回报文： 退出登录成功 ``` ## 4.0 校验用户是否登录 ###### 接口功能 > 用户通过web端或APP判断是否有权限操作相应操作接口 ###### URL > [http://api.java110.com:8008/api/check.user.hasPrivilege](http://api.java110.com:8008/api/check.user.hasPrivilege) ###### 支持格式 > JSON ###### HTTP请求方式 > POST ###### 请求参数(header部分) |参数名称|约束|类型|长度|描述|取值说明| | :-: | :-: | :-: | :-: | :-: | :-:| |app_id|1|String|30|应用ID|Api服务分配 | |transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 | |sign|1|String|-|签名|请参考签名说明| |req_time|1|String|-|请求时间|YYYYMMDDhhmmss| ###### 请求参数(body部分) |参数名称|约束|类型|长度|描述|取值说明| | :-: | :-: | :-: | :-: | :-: | :-: | |userId|1|String|30|用户ID|-| |pId|1|String|30|权限ID|-| ###### 返回协议 当http返回状态不为200 时请求处理失败 body内容为失败的原因 当http返回状态为200时请求处理成功，body内容为返回内容， ###### 举例 > 地址：[http://api.java110.com:8008/api/check.user.hasPrivilege?userId=123&pId=123](http://api.java110.com:8008/api/check.user.hasPrivilege?userId=123&pId=123) ``` javascript 请求头信息： Content-Type:application/json USER_ID:1234 APP_ID:8000418002 TRANSACTION_ID:10029082726 REQ_TIME:20181113225612 SIGN:aabdncdhdbd878sbdudn898 请求报文： 无 返回报文： 成功 ```
File was deleted docs/document/api/user/logout.md
File was deleted docs/document/api/user/register.md
File was deleted docs/document/services/Readme.md
docs/document/services/acitivities/DeleteActivitiesInfo.md
File was deleted docs/document/services/acitivities/SaveActivitiesInfo.md
File was deleted docs/document/services/acitivities/UpdateActivitiesInfo.md
File was deleted docs/document/services/advert/DeleteAdvertInfo.md
File was deleted docs/document/services/advert/DeleteAdvertItemInfo.md
File was deleted docs/document/services/advert/SaveAdvertInfo.md
File was deleted docs/document/services/advert/SaveAdvertItemInfo.md
File was deleted docs/document/services/advert/UpdateAdvertInfo.md
File was deleted docs/document/services/advert/UpdateAdvertItemInfo.md
File was deleted docs/document/services/auditMessage/DeleteAuditMessageInfo.md
File was deleted docs/document/services/auditMessage/SaveAuditMessageInfo.md
File was deleted docs/document/services/auditMessage/UpdateAuditMessageInfo.md
File was deleted docs/document/services/auditUser/DeleteAuditUserInfo.md
File was deleted docs/document/services/auditUser/SaveAuditUserInfo.md
File was deleted docs/document/services/auditUser/UpdateAuditUserInfo.md
File was deleted docs/document/services/businesstype/DeleteCbusinesstypeInfo.md
File was deleted docs/document/services/businesstype/SaveCbusinesstypeInfo.md
File was deleted docs/document/services/businesstype/UpdateCbusinesstypeInfo.md
File was deleted docs/document/services/carBlackWhite/DeleteCarBlackWhiteInfo.md
File was deleted docs/document/services/carBlackWhite/SaveCarBlackWhiteInfo.md
File was deleted docs/document/services/carBlackWhite/UpdateCarBlackWhiteInfo.md
File was deleted docs/document/services/carInout/DeleteCarInoutDetailInfo.md
File was deleted docs/document/services/carInout/DeleteCarInoutInfo.md
File was deleted docs/document/services/carInout/SaveCarInoutDetailInfo.md
File was deleted docs/document/services/carInout/SaveCarInoutInfo.md
File was deleted docs/document/services/carInout/UpdateCarInoutDetailInfo.md
File was deleted docs/document/services/carInout/UpdateCarInoutInfo.md
File was deleted docs/document/services/code/code.md
File was deleted docs/document/services/code/code_test.md
File was deleted docs/document/services/comment/comment.md
File was deleted docs/document/services/comment/comment_test.md
File was deleted docs/document/services/community/communityMemberJoined.md
File was deleted docs/document/services/community/communityMemberQuit.md
File was deleted docs/document/services/complaint/DeleteComplaintInfo.md
File was deleted docs/document/services/complaint/SaveComplaintInfo.md
File was deleted docs/document/services/complaint/UpdateComplaintInfo.md
File was deleted docs/document/services/demo/DeleteDemoInfo.md
File was deleted docs/document/services/demo/SaveDemoInfo.md
File was deleted docs/document/services/demo/UpdateDemoInfo.md
File was deleted docs/document/services/fee/DeleteFeeAttrInfo.md
File was deleted docs/document/services/fee/DeleteFeeConfigInfo.md
File was deleted docs/document/services/fee/DeleteFeeDetailInfo.md
File was deleted docs/document/services/fee/DeleteFeeInfo.md
File was deleted docs/document/services/fee/SaveFeeAttrInfo.md
File was deleted docs/document/services/fee/SaveFeeConfigInfo.md
File was deleted docs/document/services/fee/SaveFeeDetailInfo.md
File was deleted docs/document/services/fee/SaveFeeInfo.md
File was deleted docs/document/services/fee/UpdateFeeAttrInfo.md
File was deleted docs/document/services/fee/UpdateFeeConfigInfo.md
File was deleted docs/document/services/fee/UpdateFeeDetailInfo.md
File was deleted docs/document/services/fee/UpdateFeeInfo.md
File was deleted docs/document/services/file/DeleteFileRelInfo.md
File was deleted docs/document/services/file/SaveFileRelInfo.md
File was deleted docs/document/services/file/UpdateFileRelInfo.md
File was deleted docs/document/services/floor/DeleteFloorInfo.md
File was deleted docs/document/services/floor/SaveFloorInfo.md
File was deleted docs/document/services/floor/UpdateFloorInfo.md
File was deleted docs/document/services/inspectionPlan/DeleteInspectionPlanInfo.md
File was deleted docs/document/services/inspectionPlan/SaveInspectionPlanInfo.md
File was deleted docs/document/services/inspectionPlan/UpdateInspectionPlanInfo.md
File was deleted docs/document/services/inspectionPlanStaff/SaveInspectionPlanStaffInfo.md
File was deleted docs/document/services/inspectionPoint/DeleteInspectionInfo.md
File was deleted docs/document/services/inspectionPoint/SaveInspectionInfo.md
File was deleted docs/document/services/inspectionPoint/UpdateInspectionInfo.md
File was deleted docs/document/services/inspectionRoute/DeleteInspectionRouteInfo.md
File was deleted docs/document/services/inspectionRoute/SaveInspectionRouteInfo.md
File was deleted docs/document/services/inspectionRoute/UpdateInspectionRouteInfo.md
File was deleted docs/document/services/inspectionTask/SaveInspectionTaskInfo.md
File was deleted docs/document/services/junkRequirement/SaveJunkRequirementInfo.md
File was deleted docs/document/services/machine/DeleteApplicationKeyInfo.md
File was deleted docs/document/services/machine/DeleteMachineAttrInfo.md
File was deleted docs/document/services/machine/DeleteMachineInfo.md
File was deleted docs/document/services/machine/DeleteMachineRecordInfo.md
File was deleted docs/document/services/machine/DeleteMachineTranslateInfo.md
File was deleted docs/document/services/machine/SaveApplicationKeyInfo.md
File was deleted docs/document/services/machine/SaveMachineAttrInfo.md
File was deleted docs/document/services/machine/SaveMachineInfo.md
File was deleted docs/document/services/machine/SaveMachineRecordInfo.md
File was deleted docs/document/services/machine/SaveMachineTranslateInfo.md
File was deleted docs/document/services/machine/UpdateApplicationKeyInfo.md
File was deleted docs/document/services/machine/UpdateMachineAttrInfo.md
File was deleted docs/document/services/machine/UpdateMachineInfo.md
File was deleted docs/document/services/machine/UpdateMachineRecordInfo.md
File was deleted docs/document/services/machine/UpdateMachineTranslateInfo.md
File was deleted docs/document/services/msg/DeleteMsgInfo.md
File was deleted docs/document/services/msg/DeleteMsgReadInfo.md
File was deleted docs/document/services/msg/SaveMsgInfo.md
File was deleted docs/document/services/msg/SaveMsgReadInfo.md
File was deleted docs/document/services/msg/UpdateMsgInfo.md
File was deleted docs/document/services/msg/UpdateMsgReadInfo.md
File was deleted docs/document/services/notice/DeleteNoticeInfo.md
File was deleted docs/document/services/notice/SaveNoticeInfo.md
File was deleted docs/document/services/notice/UpdateNoticeInfo.md
File was deleted docs/document/services/order/order.md
File was deleted docs/document/services/order/order_config.md
File was deleted docs/document/services/org/DeleteOrgCommunityInfo.md
File was deleted docs/document/services/org/DeleteOrgInfo.md
File was deleted docs/document/services/org/DeleteOrgStaffRelInfo.md
File was deleted docs/document/services/org/SaveOrgCommunityInfo.md
File was deleted docs/document/services/org/SaveOrgInfo.md
File was deleted docs/document/services/org/SaveOrgStaffRelInfo.md
File was deleted docs/document/services/org/UpdateOrgCommunityInfo.md
File was deleted docs/document/services/org/UpdateOrgInfo.md
File was deleted docs/document/services/org/UpdateOrgStaffRelInfo.md
File was deleted docs/document/services/owner/DeleteOwnerAppUserInfo.md
File was deleted docs/document/services/owner/DeleteOwnerCarInfo.md
File was deleted docs/document/services/owner/DeleteOwnerInfo.md
File was deleted docs/document/services/owner/DeleteOwnerRoomRelInfo.md
File was deleted docs/document/services/owner/SaveOwnerAppUserInfo.md
File was deleted docs/document/services/owner/SaveOwnerCarInfo.md
File was deleted docs/document/services/owner/SaveOwnerInfo.md
File was deleted docs/document/services/owner/SaveOwnerRoomRelInfo.md
File was deleted docs/document/services/owner/UpdateOwnerAppUserInfo.md
File was deleted docs/document/services/owner/UpdateOwnerCarInfo.md
File was deleted docs/document/services/owner/UpdateOwnerInfo.md
File was deleted docs/document/services/owner/UpdateOwnerRoomRelInfo.md
File was deleted docs/document/services/parkingArea/DeleteParkingAreaInfo.md
File was deleted docs/document/services/parkingArea/SaveParkingAreaInfo.md
File was deleted docs/document/services/parkingArea/UpdateParkingAreaInfo.md
File was deleted docs/document/services/parkingSpace/DeleteParkingSpaceInfo.md
File was deleted docs/document/services/parkingSpace/SaveParkingSpaceInfo.md
File was deleted docs/document/services/parkingSpace/UpdateParkingSpaceInfo.md
File was deleted docs/document/services/purchaseApply/DeletePurchaseApplyInfo.md
File was deleted docs/document/services/purchaseApply/SavePurchaseApplyInfo.md
File was deleted docs/document/services/purchaseApply/UpdatePurchaseApplyInfo.md
File was deleted docs/document/services/purchaseApplyDetail/SavePurchaseApplyDetailInfo.md
File was deleted docs/document/services/repair/DeleteRepairInfo.md
File was deleted docs/document/services/repair/DeleteRepairUserInfo.md
File was deleted docs/document/services/repair/SaveRepairInfo.md
File was deleted docs/document/services/repair/SaveRepairUserInfo.md
File was deleted docs/document/services/repair/UpdateRepairInfo.md
File was deleted docs/document/services/repair/UpdateRepairUserInfo.md
File was deleted docs/document/services/resourceStore/DeleteResourceStoreInfo.md
File was deleted docs/document/services/resourceStore/SaveResourceStoreInfo.md
File was deleted docs/document/services/resourceStore/UpdateResourceStoreInfo.md
File was deleted docs/document/services/returnPayFee/SaveReturnPayFeeInfo.md
File was deleted docs/document/services/room/DeleteRoomAttrInfo.md
File was deleted docs/document/services/room/DeleteRoomInfo.md
File was deleted docs/document/services/room/SaveRoomAttrInfo.md
File was deleted docs/document/services/room/SaveRoomInfo.md
File was deleted docs/document/services/room/UpdateRoomAttrInfo.md
File was deleted docs/document/services/room/UpdateRoomInfo.md
File was deleted docs/document/services/shop/shop.md
File was deleted docs/document/services/shop/shop_test.md
File was deleted docs/document/services/smallWeChat/SaveSmallWeChatInfo.md
File was deleted docs/document/services/store/store.md
File was deleted docs/document/services/store/store_test.md
File was deleted docs/document/services/task/DeleteTaskInfo.md
File was deleted docs/document/services/task/SaveTaskInfo.md
File was deleted docs/document/services/task/UpdateTaskInfo.md
File was deleted docs/document/services/taskAttr/DeleteTaskAttrInfo.md
File was deleted docs/document/services/taskAttr/SaveTaskAttrInfo.md
File was deleted docs/document/services/taskAttr/UpdateTaskAttrInfo.md
File was deleted docs/document/services/unit/DeleteUnitInfo.md
File was deleted docs/document/services/unit/SaveUnitInfo.md
File was deleted docs/document/services/unit/UpdateUnitInfo.md
File was deleted docs/document/services/user/user.md
File was deleted docs/document/services/user/user_test.md
File was deleted service-job/src/main/resources/application-dev.yml
@@ -20,7 +20,7 @@ defaultZone: http://dev.java110.com:8761/eureka/ #defaultZone: http://localhost:8761/eureka/ server: port: 8086 port: 8013 tomcat: uri-encoding: UTF-8
