OSAM 국방 모바일 반납
  • 국방 모바일 반납
  • ABOUT PROJECT
    • 개발 동기
    • 개발 목표
    • 개발 일정
  • HOW TO COLLABORATE
    • Notion
    • Git Workflow
    • Git Contribution
    • CI/CD
    • API Documenation
  • Technical Note
    • 시스템 구성
    • 작동 시나리오
    • 분야별 기능
      • WEB 기능
      • APP 기능
      • IoT 기능
    • Time-based OTP 인증
  • HOW TO BUILD
    • WEB
    • APP
    • IoT
  • HOW TO USE
    • 관리자 설정
    • 기기 등록
    • 기기 반납
    • 현황 파악
  • ADVANCED
    • QR코드 색상암호화
    • 1:N 반납기
    • 아두이노 미사용
    • 관리자용 APP
    • 본 프로젝트에 대한 비평
  • License
    • WEB License
    • APP License
    • IoT License
Powered by GitBook
On this page
  • API Documentation
  • 부가설명
  • api-admin-controller
  • api-device-return-controller
  • api-restart-controller
  • api-return-log-controller
  • api-time-based-otp-auth-controller
  • index-controller

Was this helpful?

  1. HOW TO COLLABORATE

API Documenation

swagger api documentation library

PreviousCI/CDNext시스템 구성

Last updated 4 years ago

Was this helpful?

Swagger 라이브러리를 이용하여 Spring Boot 어플리케이션에 API가 추가될 때마다 자동으로 문서화하여 다른 분야 개발자들이 참고할 수 있는 API 문서를 만들어 주고 요청을 보내서 서버의 실제 응답을 받아볼 수도 있어 협업에 용이하기 때문에 사용하였다.

API Documentation

​https://osam.riyenas.dev/swagger-ui.html​

부가설명

api-admin-controller

  • /api/admin/create : 신규 관리자를 등록하는 API

  • /api/admin/find/all : 모든 기존 관리자를 조회하는 API

  • /api/admin/find/signUpCode/{signUpCode} : 관리자의 회원가입 코드를 통해 관리자의 정보를 조회하는 API

api-device-return-controller

  • /api/soldier/create : 병사의 기기를 새로 등록하는 API

  • /api/soldier/find/admin/serviceNumber/{adminServiceNumber} :

  • /api/soldier/find/admin/signUpCode/{signUpCode} : 회원가입 코드를 기준으로 등록된 병사를 조회하는 API

  • /api/soldier/find/all : 등록된 모든 병사의 정보를 조회하는 API

  • /api/soldier/return/status : 등록된 모든 병사의 반납 상태를 조회하는 API

  • /api/soldier/return/status/admin/{adminId} : 특정 관리자에게 소속된 병사들의 반납 상태를 조회하는 API

  • /api/soldier/return/time/valid : 현재 시간이 특정 관리자가 설정한 핸드폰 사용가능 시간인지 조회하는 API

api-restart-controller

  • /api/restart : 서버를 재시작해 등록된 모든 정보를 초기화하는 API (시연용)

api-return-log-controller

  • /api/log/create : 특정 병사의 반납 기록을 새로 생성하는 API

  • /api/log/delete/all : 모든 반납 기록을 삭제하는 API

  • /api/log/find/id : 특정 병사의 반납 기록을 조회하는 API

  • /api/log/find/all : 모든 병사의 반납 기록을 조회하는 API

  • /api/log/find/device/{deviceId} : 특정 기기의 반납 기록을 조회하는 API

  • /api/log/find/device/{deviceId}/last : 특정 기기의 마지막 반납 기록을 조회하는 API

  • /api/log/find/return/fault : 모든 비정상 반납 기록을 조회하는 API

  • /api/log/find/return/fault : 모든 정상 반납 기록을 조회하는 API

api-time-based-otp-auth-controller

  • /api/totp/generate : seed와 시간으로부터 TOTP값을를 계산하는 API

  • /api/totp/generate/device/{deviceId} : 특정 기기의 현재 TOTP값을 계산하는 API

  • /api/totp/generate/device/{deviceId}/qrcode : 특정 기기가 현재 생성하여 QR코드로 변환해야 하는 JSON을 생성하는 API

  • /api/totp/generate/seed/{seed} : 특정 seed를 기반으로 현재 TOTP값을 계산하는 API

  • /api/totp/transfer/qrcode/{deviceId} : 특정 기기가 현재 출력해야 하는 QR코드를 생성하는 API

  • /api/totp/valid : 특정 기기가 특정 시간에 생성한 TOTP를 검증하는 API

index-controller

  • / : 메인 페이지

  • /admin : 관리자 페이지

  • /log/all : 전체 반납 기록 페이지

  • /log/fault : 비정상 반납 기록 페이지

  • /soldier : 등록된 병사 목록 페이지