[AIoT] 무인 사물함 프로젝트 관리자 관점 명세 정의

개요

주제가 AIoT프로젝트인 만큼 웹 기술적인 면에서 API의 종류가 많거나 하지는 않다.

따라서 사용자 페이지 이외에도 사용 이력 조회, 로봇 상태 조회, 유저 정보 조회, DAU, MAU 조회 등 관리자를 위한 페이지를 만들기로 명세하였다.

관리자 명세는 하기와 같다.

 

 

관리자 로그인 기능 명세

1. 클라이언트에서 adminId와 adminPassword를 전달받는다.
2. 관리자 목록 테이블에 adminId가 존재하며 adminPassword가 일치한다면 로그인 성공 메시지를 리턴한다.
3. 만약 일치하지 않는다면 관련 메시지를 리턴하고 예외를 던져준다.

 

로봇 정보 출력 명세

1. 클라이언트로 부터 관련 요청이 올 경우 로봇 테이블에 존재하는 로봇 관련 칼럼 데이터를 모두 가져온다.
2. 클라이언트에게 로봇Id, 로봇이름, 작업 완료 횟수, 최근 유지 보수 시간, 현재 로봇 상태를 리턴해준다.

 

사용자 이용 현황 출력 명세

1. 클라이언트로 부터 관련 요청이 올 경우 로그 테이블에서 사용자 별 사용 횟수를 가져온다.
2. 유저 Id를 통해 그룹을 짓고, 유저Id를 기준으로 데이터를 오름차순 정렬해 준다.
3. 클라이언트에게 유저Id, 핸드폰 번호, 사용 횟수를 리턴해 준다.

해당 API는 기간별 사용자 이용 현황에 대한 API로 확장될 가능성이 있다.

 

 

기간별 사용 현황 출력 명세

1. 클라이언트로 부터 시작 시간과 종료 시간을 yyyy-MM-dd hh:mm 형식으로 전달받는다.
2. 로그 테이블에서 보관 시간이 시작 시간과 종료 시간 사이인 데이터를 logId를 기준으로 오름차순 정렬해 준다.
3. 클라이언트에게 로그Id, 사물함 번호, 유저Id, 보관 시각, 보관 작업을 진행한 로봇Id, 반환 완료 시각(없다면 NULL), 반환 작업을 진행한 로봇Id(없다면 NULL)을 리턴해 준다.

 

요약

현재 까지 확정된 관리자 관련 기능 명세는 여기까지이다.

하지만 관리자 기능이 추가될 때 마다 DB에 저장된 데이터를 적절히 파싱하여 출력하거나, 데이터를 변경하는 로직에 사용할 수 있다.