openapi-univ-korea

고려대학교 통합 API 서버 라이브러리

1. 고려대학교 API란?

고려대학교 및 관련 업체에서는 다양한 정보 (재학생 확인, 성적, 도서관 좌석 및 기숙사 식단) 를 웹 서비스를 통해 제공하고 있지만, 이는 대부분 html 문서로 되어 있어 별도의 추출 작업이 필요하거나, 복잡한 요청을 필요로 합니다.

본 라이브러리에서는 이러한 데이터를 요청하여 파싱해 JSON 또는 기타 포맷으로 제공하여, 통계 제공 및 재학생, 교직원에게 유익한 서비스를 제작할 때 편리하게 사용할 수 있도록 도와줍니다.

2. 지원 언어 및 플랫폼

언어	플랫폼
Python3	django, djangorestframework

3. 설치

Python3

pip3 install openapi-univ-korea

운영 대상 django 프로젝트의 settings.py 에 패키지를 로드합니다.

INSTALLED_APPS = [
    # ...

    'rest_framework',
    'rest_framework.authtoken',
    'django_filters',

    'kuapi' # kuapi 패키지 로드
]

데이터베이스 모델을 마이그레이션합니다.

python3 manage.py migrate kuapi

각 기능 예제 및 클라이언트 API는 기능별 문서를 참고하시기 바랍니다.

4. 지원 기능

기능	개발 문서	API 문서 (클라이언트)
수업 시간표 조회,검색	LINK	LINK - Swagger docs

5. 추가 예정 기능

고대인 확인 (캠퍼스 확인 가능)

학적사항조회 (이름, 생년월일, 성별)

수강신청 내역조회

전체 성적 조회

수강신청 서버 상태 확인 (응답 시간, 서버 시간, 사용량 (netfunnel wating user 수))

기타 서버 상태 확인 (블랙보드, 정보 제공 서버 ex> grw))

[고대인 인증 필요] 학사일정, 지난 학사일정 열람

[고대인 인증 필요] 강의 검색, 시간 및 강의실, 강의정보 확인

[세종] 도서관 - 학술정보원 열람실 좌석 현황 확인 및 저장 (월, 일, 시간별 사용량 통계 제공)

[세종] 기숙사 - 호연사관 매주 학식 식단 제공 및 저장

6. 면첵공지 및 유의사항

⚠️ 본 소프트웨어 사용에 있어 다음 사항을 잘 숙지하고 유의해 주시기 바랍니다.

1)

7. 문의

사용중 궁금하거나 문의 사항이 있으시면, 본 repo 에 issue 를 만들어 주시거나, 제 이메일 계정(클릭하여 확인) 으로 연락 주시기 바랍니다.