swagger

test

2022年07月26日(화) ~ 2022年08月02日(화)

• 학교 관리자는 학교를 페이지를 운영하여 학교 소식을 발행할 수 있다.

  • 학교 관리자는 지역, 학교명으로 학교 페이지를 생성할 수 있다.
  • 학교 관리자는 학교 페이지 내에 소식을 작성할 수 있다.
  • 학교 관리자는 작성된 소식을 삭제할 수 있다.
  • 학교 관리자는 작성된 소식을 수정할 수 있다.

• 학생은 학교 페이지를 구독하여 학교 소식을 받아 볼 수 있다.

  • 학생은 학교 페이지를 구독할 수 있다.
  • 학생은 구독 중인 학교 페이지 목록을 확인할 수 있다.
  • 학생은 구독 중인 학교 페이지를 구독 취소할 수 있다.
  • 학생은 구독 중인 학교 페이지별 소식을 볼 수 있다.
    • 학교별 소식은 최신순으로 노출해야함

• 학생은 구독 중인 학교 소식을 자신의 뉴스피드에서 모아볼 수 있다.

  • 구독중인 모든 학교의 소식을 모아볼 수 있어야함
  • 학교 소식이 노출되는 뉴스피드는 최신순으로 소식을 노출
  • 학교페이지를 구독하는 시점 이후 소식부터 뉴스피드를 받음
  • 학교 페이지 구독을 취소해도 기존 뉴스피드에 나타난 소식은 유지해야 함.

• 단위 테스트 또는 통합 테스트를 구현해주세요.

• 구현에 맞는 API 명세를 문서화해주세요.

  • Swagger
  • README

NestJS, Docker, TypeORM, MySQL

• exception filter
• swagger
• jwt, passport
• typeorm
• docker, docker-compose

• POST /api/signup 회원가입
  • 정상 테스트
  • 형식 불량
    • 이메일
    • 비밀번호
    • 이름
    • 닉네임
  • 중복
    • 이메일
    • 닉네임

• POST /auth/login 로그인
  • 정상 테스트
  • 오류
    • 존재하지 않는 계정 ( 이메일 )
    • 다른 비밀번호 입력
  • 형식 불량
    • 이메일
    • 비밀번호
• POST /auth/logout 로그아웃
  • 정상 테스트
  • 토큰 누락
• POST /auth/restore 토큰 재발급
  • 정상 테스트
  • 토큰 누락

• GET /admin/school/my
  • 정상 테스트
    • 빈 값
    • 생성한 학교 페이지 목록
  • 미권한 유저
  • 형식 불량
    • 토큰 누락
• POST /admin/school
  • 정상 테스트
    • 단일 생성
    • 다중 생성
  • 미권한 유저
  • 형식 불량
    • 이름 누락
    • 지역 누락
    • 토큰 누락
  • 중복
    • 이름 중복
• PUT /admin/school
  • 정상 테스트
    • 이름, 지역 변경
    • 이름 변경
    • 지역 변경
  • 미권한 유저
  • 미권한 관리자
  • 중복
    • 이름 중복
  • 형식 불량
    • UUID 미입력
    • 이상한 UUID 입력
    • 토큰 누락
• DELETE /admin/school
  • 정상 테스트
    • 삭제
  • 미권한 유저
  • 미권한 관리자
  • 형식 불량
    • UUID 미입력
    • 이상한 UUID 입력
    • 토큰 누락

• GET /api/subscribe/list
  • 정상 테스트
    • 빈 값
    • 0, 1번 째 학교
    • 2, 3번 째 학교
  • 형식 불량
    • 토큰 누락
• GET /api/subscribe/news/:school
  • 정상 테스트
    • 빈 값
    • 0 ~ 4번 째 소식
  • 형식 불량
    • 토큰 누락
    • Param 누락
    • 잘못된 Param
• POST /api/subscribe
  • 정상 테스트
  • 중복
    • 동일한 관리자
    • 동일한 사람이 동일한 학교에 두 번 요청함
  • 형식 불량
    • 토큰 누락
    • UUID 누락
    • 이상한 UUID 입력
• DELETE /api/subscribe
  • 정상 테스트
  • 형식 불량
    • 토큰 누락
    • UUID 미입력
    • 이상한 UUID 입력

• POST /admin/school/news
  • 정상 테스트
    • 요청
  • 미권한
    • 유저
    • 관리자
  • 형식 불량
    • 토큰 누락
    • UUID 누락
    • 제목 누락
    • 내용 누락
    • 이상한 UUID 입력
• PUT /admin/school/news
  • 정상 테스트
    • 제목 수정
    • 내용 수정
    • 제목, 내용 수정
  • 미권한
    • 유저
    • 관리자
  • 형식 불량
    • 토큰 누락
    • UUID 누락
    • 이상한 UUID 입력
• PATCH /admin/school/news
  • 정상 테스트
    • 삭제 취소
  • 미권한
    • 유저
    • 관리자
  • 형식 불량
    • 토큰 누락
    • UUID 누락
    • 이상한 UUID 입력
• DELETE /admin/school/news
  • 정상 테스트
    • 삭제
  • 미권한
    • 유저
    • 관리자
  • 형식 불량
    • 토큰 누락
    • UUID 누락
    • 이상한 UUID 입력

• GET /api/newsfeed
  • 정상 테스트
    • 빈 값
    • 일반 요청
    • 구독 해제 후 요청
    • 구독 해제 후 관리자가 게시글을 업로드한 뒤 요청
    • 구독 해제 후 관리자가 게시글을 업로드한 후 다시 구독한 후 요청
  • 형식 불량
    • 토큰 누락