agile wroking backend

agile-wroking-backend

此專案是real world小程序AgileWorking應用的後端， AgileWorking是用於部門內部會議室及團隊管理的小程序，小程序的前端實作可以存取此專案agile-working。

特色

• 全面運用Java8函數式編碼風格，程式碼簡潔、高效，易讀
• 採用領域模型設計的風格組織程式碼，應對複雜邏輯
• 使用SpringBoot構建， Convension Over Configuration ，零配置
• 提供Restful風格的API 易於前端訪問
• 支援小程式的會話管理及介面呼叫的安全控制
• 支持會議提醒及邀請其他人加入會議

示範

建構

前置條件

• Jdk1.8+
• 安裝配置Maven
• 安裝Git

建置步驟

• git clone https://github.com/7upcat/agile-wroking-backend.git
• cd agile-working-backend
• mvn package
• java -jar targetagile-working-backend-1.0.3.jar

單元測試

• 進行單元測試前在src/main/resources/application.properties中設定profile spring.profiles.active=dev ，將會自動連接測試的資料庫，並在每個案例執行前重新建表
• 進行單元測試mvn test

介面清單

介面設計遵循Restful風格的API ，公開標籤下的服務可以直接訪問，私有標籤的服務必須在http header 中指定Authorization （Token） 及Subject （微信openId）：

• 【公開】透過jsCode取得使用者的openId /agileworking/wechat/openid/{jsCode} ，成功查詢payload 中傳回的即是openId

• 【公開】查詢團隊列表，回傳所有的團隊/agileworking/teams

• 【公開】查詢指定openId的使用者是否有加入指定的團隊GET /agileworking/team/{teamId}/user/{openId} ，如果加入則傳回User資訊及token

• 【公開】加入指定的團隊POST /agileworking/team/{id}/join ，加入成功會返回User及token

  • name/姓名
  • mobileNo/手機號
  • openId/微信openId
  • nickName/微信暱稱
  • avatarUrl/微信頭像url
  • token/團隊的加入口令

• 【公開】根據id查詢指定的排期GET /agileworking/schedules/{id} ，含排期的參與人，此介面用於邀請其他使用者開啟小程式時使用，暫時放開為公共，後續待前端優化後修改回私有

• 【私有】查詢指定團隊下的所有會議室清單GET /agileworking/meetingRooms/{teamId}

• 【私有】建立/修改排期POST /agileworking/meetingRooms/{id}/schedule?formId=?

  • id/排期id（可選，建立排期為空）
  • title/標題
  • date/日期yyyy-MM-dd格式
  • startTime/開始時間(hh:min)
  • endTime/結束時間(hh:min)
  • creatorOpenId/創建人微信openId
  • creatorNickName/創建人微信暱稱
  • creatorAvatarUrl/創建人微信頭像URL
  • repeatMode/會議重複模式（N-不重複/W-每週）

• 【私有】取消排期DELETE /agileworking/meetingRooms/schedule/{id}

• 【私有】查詢指定會議室指定日期的排程GET /agileworking/meetingRooms/{id}/schedule?date=yyyyMMdd

• 【私有】接受會議邀請POST /agileworking/schedules/{id}/join

  • openId/接受邀請人微信openId
  • nickName/接受邀請人微信暱稱
  • avatarUrl/接受邀請人微信頭像URL
  • formId/表單id ，用於後續的微信訊息通知

• 【私有】查詢加入的會議GET /agileworking/participant/{openId}?date=yyyyMMdd

  • scheduleId/排期id
  • meetingRoomId/會議室id
  • date/排期的日期
  • title/會議主題
  • openId/參加者的微信openId
  • roomNo/會議室
  • startTime/開始時間
  • endTime/結束時間
  • repeatMode/會議重複模式（N-不重複/W-每週）