🥹(초보)Canvas LMS API 분석하기 (대학 강의 사이트)

⚠️공사중, 설명이 중구난방일 수 있습니다
언젠가.. 글 잘쓰게 되면 다듬어보겠습니다

🙂알아보기

API 찾기 위한 과정

처음엔 api를 검색해봤지만, 도저히 내 대학교가 사용하는 프로그램과 같은 api 를 찾지 못하였다

지금 보니 Extended라 적혀있는데 영어를 못한거였네요
그래서 또 열어서 스크래핑 해야 하는건가? 로그인은 어떻게 하지? 하는 잡생각이 들어서 머리가 어지러워질때쯤

누가 API를 찾아주셨다 감사합니다감사합니다

⭐python 동작

초보라? REST? 할줄 모릅니다

누가 이미 python으로 만들어 놓지 않았을까 생각해서 찾아봤다.

이미 있어서 간편하게 사용할 수 있었다. 매우 고마우니 star 누르고 사용하기

ucfopen/canvasapi
그리고 docs가 깔끔하진 않지만 있는거로 만족해요

🔍살펴보기

뭘 찾아야 하는가?

일단 학교에서 사용중인 탭을 살펴보자

깔끔하게 있는 것 같아 보이지만, 그렇지 않다. 강의 컨텐츠탭은 실행 속도가 오래 걸리고, 과제 및 평가에는 과제 뿐만 아니라 공지까지 표시가 되는 등 여러므로 분리가 잘 안되어있다.

지금 추측하건데, 아마 기존 Canvas LMS를 쓰지 않고 다른 방식을 사용함에 따라 나온 결과가 아닌가 싶다.

이런 추측이 나올 수 있는게, 문의게시판 부터 강의자료실 등의 여러 가지 탭의 링크가 external_tools로 대충 정리가 되어있다

아무튼 우리는 강의 정보와 과제, 컨텐츠, 공지를 api를 통해 찾아야 한다

잘 작동하는가?

패캐지에 나와있는 대로 일단 따라가 보자, canvas 정보를 가져오기위해서는 API_URL (보통은 대학교 LMS 주소이다), token(LMS 로그인 후 설정란에서 token을 받아올 수 있다)이 필요하다.

우리가 얻어와야 할 정보는 Course 강의 정보이다
강의 정보를 잘 불러오고 있는지 체크해보자

import canvasapi
canvas = canvasapi.Canvas(API_URL, TOKEN)
for course in canvas.get_courses():
    try:
        print(course)
    except AttributeError:
        pass

AttributeError 예외처리를 한 이유는 course 데이터 중에 권한이 부족하거나 비어있는 course가 존재했기 때문이다.. 아마 전학기에 들었던 강의 데이터가 저장되어있는게 아닐까 추측해보며, 현재 강의 정보만 잘 걸러내자.

🤔 PaginatedList가 뭐죠?

🔍따로 분석해보았다!🔍

권한이 부족하지만 상관이 없어요

가끔씩 권한이 부족하다는 메세지와 함께 예외처리를 내뿜는 경우가 있다. 심지어 권한이 부족하지도 않은데 변수가 존재하지 않아서 (api에는 선택적으로 존재한다고 표시 되어있다) 에러가 나는 경우가 있다. 이를 조심하며 기록해나가면서 필요한 정보를 가져와보자.

😊 구조 분석 & 자료 정리

재미로 뜯어본건 아니고 하도 원하는 정보가 안나와서 분석한 결과이다

공사중, 조금더 내용을 넣을 예정입니다!

• Course : 강의 객체이다. 현재 진행되고 있는 강의인지 잘 살펴봐야 한다. get_courses()를 통해 Canvas 클래스에서 가져올 수 있다.
  • id : 강의의 고유 id 값이다.
  • name : 강의의 이름 값이다.
• Assignment : 과제(라고 부르지만 컨텐츠 잡탕) 객체이다. get_assignments()를 통해 Course 클래스에서 가져올 수 있다.
  • id : 과제의 고유 id 값이다.
  • workflow_state : 현재 과제의 상태를 확인할 수 있다.
  • 가장 중요한 과제의 종류가 나오지 않는다..
• Module : 모듈이라 되어있지만, 묶음 이라 생각하는게 편하다. get_modules()를 통해 Course 클래스에서 가져올 수 있다.

  TODO : 더 작성할 것 (졸려잉)

뜯어보며 정리한 자료 (마크다운)

📑해야 할 것 (OAuth)

초반에 만들 때에는 테스트를 위해 직접 내 데이터 정보를 토큰을 만들어서 받아와야 했다.

대학 사이트를 가져올 프로그램을 만들었으니, 이제 사용자가 이 프로그램을 쓸 수 있게 사용자의 LMS 사용 요청을 받는 OAuth를 이용해야 한다

그런데..

참고: 개발자 키는 계정 권한입니다. 계정 탐색에서 개발자 키 링크를 볼 수 없다면 해당 사용자 계정에 대해 이 권한이 활성화되지 않은 것입니다.

☹️

고난이 예상된다!