Skip to content

wwlee94/aws-lambda-lecture-management-api

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
CSV_Import_DynamoDB
CSV_Import_DynamoDB
 
 
img
img
 
 
library/nodejs
library/nodejs
 
 
src
src
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
auto_deploy.bat
auto_deploy.bat
 
 
index.zip
index.zip
 
 

Repository files navigation

프로그래머스 윈터 코딩 앱 개발 과제를 위한 API

강의 관리 API

강의 목록을 조회할 수 있고 각 사용자별로 추가한 강의를 조회, 저장, 삭제 해주는 API

개발해야 할 화면 구성

screenshot_1

강의 관리 API가 제공 하는 기능들

  1. Lectures API로 강의 목록을 조회 할 수 있습니다.
  • 모든 강의 목록을 가져올 수 있습니다.
  • 강의 코드만으로 원하는 강의 정보를 조회할 수 있습니다.
  • 특정 이름으로 시작하는 모든 강의를 검색할 수 있습니다.
  1. Timetable API로 강의를 추가하거나 삭제하거나 추가한 강의를 조회 할 수 있습니다.
  • 원하는 강의를 저장할 수 있습니다.
  • 추가한 강의를 삭제할 수 있습니다.
  • 추가한 강의를 모두 조회할 수 있습니다.

조회하면 저장된 모든 강의코드를 반환합니다.

  1. Memo API로 추가한 강의에 메모를 쓰거나 삭제하거나 작성한 메모를 조회할 수 있습니다.
  • 작성한 모든 메모를 조회할 수 있습니다.
  • 특정 강의의 메모만 조회할 수 있습니다.
  • 강의에 메모를 추가 할 수 있습니다.

    메모 종류는 시험, 과제, 스터디 3가지 종류만 있습니다.

  • 추가한 메모를 삭제 할 수 있습니다.

    삭제 기능은 기본 요구 사항에 포함되지 않습니다.

API REFERENCE

BASE URL

API 접근 키 (x-api-key)

  • QJuHAX8evMY24jvpHfHQ4pHGetlk5vn8FJbk70O6

    Request Header에 추가해서 요청해야 API 사용이 가능합니다.

Lectures API

강의 목록을 조회 할 수 있는 API

GET /lectures -> 전체 강의 목록을 반환합니다.

GET /lectures?code={강의코드} -> code 값과 동일한 강의 정보가 반환됩니다.

GET /lectures?lecture={강의이름} -> lecture로 시작하는 과목명을 모두 반환합니다. (대소문자 구분)

Lectures API 요청 - GET 메소드

강의 목록을 조회 할 수 있는 메소드

Request Header 구조

GET /lectures
x-api-key: {x-api-key}
Content-Type: application/json
Header Description
x-api-key 강의 관리 API를 이용하기 위한 key

QueryParameter (선택)

Parameter Type Description
code String 강의 코드 ('PG1807-??' 형식)
lecture String 강의 이름

요청 예시 - cURL

curl -G https://k03c8j1o5a.execute-api.ap-northeast-2.amazonaws.com/v1/programmers/lectures -H "x-api-key : QJuHAX8evMY24jvpHfHQ4pHGetlk5vn8FJbk70O6" -H "Content-Type: application/json"

Response Body 예시

{
    "Items": [
        {
            "code": "PG1807-01",
            "lecture": "World Wide English 1",
            "professor": "Caitlyn Lee",
            "location": "혜인관403",                        
            "start_time": "10:45",
            "end_time": "12:30",
            "dayofweek": [
                "금",
                "월"
            ]                        
        }
    ],
    "Count": 1,
    "ScannedCount": 1
}

Response Body 설명

Column Type Description
code String 강의 코드
lecture String 강의 이름
professor String 교수 이름
location String 강의실
start_time String 강의 시작시간
end_time String 강의 종료시간
dayofweek StringSet 강의 요일

Response Status Code

Status Code Description
200 OK 성공
400 Bad Request 클라이언트 요청 오류 - code, lecture가 빈값일 때
403 Forbidden x-api-key 인증 에러
403 Forbidden URL 경로, HTTP method 오류
500 Internal Server Error 서버에 문제가 있을 경우

TimeTable API

사용자별로 강의를 추가하거나 삭제하거나 추가한 강의를 조회 할 수 있는 API

GET /timetable?user_key={사용자 ID 토큰} -> user_key로 등록 했던 강의 코드를 모두 반환

POST /timetable -> 사용자가 새로운 강의 코드를 추가합니다.

DELETE /timetable -> 사용자의 추가된 강의 코드를 삭제합니다.

Timetable API 요청 - GET 메소드

사용자별로 추가한 강의 코드를 모두 조회할 수 있는 메소드

  • 요청 변수 없을 시 -> 조회 불가

Request Header 구조

GET /timetable
x-api-key: {x-api-key}
Content-Type: application/json
Header Description
x-api-key 강의 관리 API를 이용하기 위한 key

QueryParameter (필수)

Parameter Type Description
user_key String 사용자 ID 토큰 (프로그래머스에서 지급 받은 토큰)

요청 예시 - cURL

curl -G https://k03c8j1o5a.execute-api.ap-northeast-2.amazonaws.com/v1/programmers/timetable?user_key=token_key_grepp -H "x-api-key : QJuHAX8evMY24jvpHfHQ4pHGetlk5vn8FJbk70O6" -H "Content-Type: application/json"

Response Body 예시

{
    "Items": [
        {
            "lecture_code": "PG1807-10"
        }
    ],
    "Count": 1,
    "ScannedCount": 1
}

Response Body 설명

Column Type Description
lecture_code String 강의 코드

Response Status Code

Status Code Description
200 OK 성공
400 Bad Request 클라이언트 요청 오류 - user_key가 없거나 빈값일 때
403 Forbidden x-api-key 인증 에러
403 Forbidden URL 경로, HTTP method 오류
500 Internal Server Error 서버에 문제가 있을 경우

Timetable API 요청 - POST, DELETE 메소드

사용자별로 원하는 강의 코드를 추가, 삭제 할 수 있는 메소드

  • 요청 변수 없을 시 -> 추가, 삭제 불가
  • user_key, code는 필수 요청 파라미터

    두가지 요청 파라미터가 있어야 추가, 삭제 가능

Request Header 구조

POST /timetable
x-api-key: {x-api-key}
Content-Type: application/json

DELETE /timetable
x-api-key: {x-api-key}
Content-Type: application/json
Header Description
x-api-key 강의 관리 API를 이용하기 위한 key

Request Body 요청 예시 (필수)

{
  "user_key":"{사용자 ID 토큰}",
  "code" : "PG1807-01"
}
Parameter Type Description
user_key String 사용자 ID 토큰 (프로그래머스에서 지급 받은 토큰)
code String 강의 코드 ('PG1807-??' 형식)

요청 예시 - cURL

POST 추가 예시
curl -X POST -d "{\"user_key\":\"token_key_grepp\",\"code\":\"PG1807-12\"}" https://k03c8j1o5a.execute-api.ap-northeast-2.amazonaws.com/v1/programmers/timetable -H "x-api-key : QJuHAX8evMY24jvpHfHQ4pHGetlk5vn8FJbk70O6" -H "Content-Type: application/json"
DELETE 삭제 예시
curl -X DELETE -d "{\"user_key\":\"token_key_grepp\",\"code\":\"PG1807-12\"}" https://k03c8j1o5a.execute-api.ap-northeast-2.amazonaws.com/v1/programmers/timetable -H "x-api-key : QJuHAX8evMY24jvpHfHQ4pHGetlk5vn8FJbk70O6" -H "Content-Type: application/json"

Response

Status Code Description
200 OK 성공
400 Bad Request 클라이언트 요청 오류 - user_key, code가 없거나 빈값일때
403 Forbidden x-api-key 인증 에러
403 Forbidden URL 경로, HTTP method 오류
403 Forbidden 유효하지 않은 사용자 ID 토큰일 떄
409 Conflict 데이터 추가시 이미 있는 데이터가 존재할 때(중복)
422 Unprocessable Entity 데이터 삭제시 없는 데이터를 삭제하려 할 때
500 Internal Server Error 서버에 문제가 있을 경우

Memo API

추가한 강의에 메모를 쓰거나 메모를 삭제하거나 작성한 메모를 조회할 수 있는 API

GET /memo?user_key={사용자 ID 토큰} -> 작성한 모든 메모를 조회할 수 있습니다.

GET /memo?user_key={사용자 ID 토큰}&code={강의 코드} -> code 이름의 특정 강의 메모만 조회할 수 있습니다.

POST /memo -> 특정 강의에 메모를 추가 할 수 있습니다.

DELETE /memo -> 특정 강의의 메모를 삭제 할 수 있습니다.

Memo API 요청 - GET 메소드

강의에 추가된 메모를 조회 할 수 있는 메소드

Request Header 구조

GET /memo
x-api-key: {x-api-key}
Content-Type: application/json
Header Description
x-api-key 강의 관리 API를 이용하기 위한 key

QueryParameter (선택)

Parameter Type Description
user_key String 사용자 ID 토큰 (프로그래머스에서 지급 받은 토큰)
code String 강의 코드 ('PG1807-??' 형식)

요청 예시 - cURL

curl -G https://k03c8j1o5a.execute-api.ap-northeast-2.amazonaws.com/v1/programmers/memo?user_key=token_key_grepp -H "x-api-key : QJuHAX8evMY24jvpHfHQ4pHGetlk5vn8FJbk70O6" -H "Content-Type: application/json"

Response Body 예시

{
    "Items": [
        {
            "user_key": "token_key_grepp",
            "lecture_code": "PG1807-01",
            "type": "EXAM",
            "title": "일정 추가하기",
            "description": "중간 고사",            
            "date": "2019-10-28",            
        }
    ],
    "Count": 1,
    "ScannedCount": 1
}

Response Body 설명

Column Type Description
user_key String 요청 했던 사용자 ID 토큰
lecture_code String 강의 코드
type String 강의 타입
title String 메모 제목
description String 메모 설명
date String 메모 작성일

Response Status Code

Status Code Description
200 OK 성공
400 Bad Request 클라이언트 요청 오류 - user_key, code가 빈값일 때
403 Forbidden x-api-key 인증 에러
403 Forbidden URL 경로, HTTP method 오류
500 Internal Server Error 서버에 문제가 있을 경우

Memo API 요청 - POST 메소드

원하는 강의에 메모를 추가할 수 있는 API

Request Header 구조

POST /memo
x-api-key: {x-api-key}
Content-Type: application/json
Header Description
x-api-key 강의 관리 API를 이용하기 위한 key

Request Body 요청 예시 (필수)

  {
    "user_key": "{사용자 ID 토큰}",
    "code": "PG1807-50",
    "type": "STUDY",
    "title": "스터디",
    "description": "스터디 시작",
    "date": "2019-10-28"
  }
POST 추가 예시
curl -X POST -d "{\"user_key\":\"{사용자 ID 토큰}\",\"code\":\"PG1807-50\",\"type\":\"STUDY\",\"title\":\"study\", \"description\" : \"study start\", \"date\" : \"2019-10-28\"}" https://k03c8j1o5a.execute-api.ap-northeast-2.amazonaws.com/v1/programmers/memo -H "x-api-key : QJuHAX8evMY24jvpHfHQ4pHGetlk5vn8FJbk70O6" -H "Content-Type: application/json"

Response Status Code

Status Code Description
200 OK 성공
400 Bad Request 클라이언트 요청 오류 - 요청 변수가 공백이거나 없을 때
403 Forbidden x-api-key 인증 에러
403 Forbidden URL 경로, HTTP method 오류
403 Forbidden 유효하지 않은 사용자 ID 토큰일 때
409 Conflict 이미 등록된 메모 타입이거나 시간표에 등록되지 않은 강의에 메모를 추가하려 할 때
422 Unprocessable Entity 형식에 맞지 않는 강의 코드, 메모 타입, 메모 날짜를 요청 했을 때
500 Internal Server Error 서버에 문제가 있을 경우

Memo API 요청 - DELETE 메소드 (기본 요구 사항 포함 안됨)

원하는 강의의 메모를 삭제할 수 있는 API

Request Header 구조

DELETE /memo
x-api-key: {x-api-key}
Content-Type: application/json
Header Description
x-api-key 강의 관리 API를 이용하기 위한 key

Request Body 요청 예시 (필수)

  {
    "code": "PG1807-50",
    "user_key": "{사용자 ID 토큰}",
    "type": "STUDY"
  }
DELETE 추가 예시
curl -X DELETE -d "{\"user_key\":\"{사용자 ID 토큰}\",\"code\":\"PG1807-50\",\"type\":\"STUDY\"}" https://k03c8j1o5a.execute-api.ap-northeast-2.amazonaws.com/v1/programmers/memo -H "x-api-key : QJuHAX8evMY24jvpHfHQ4pHGetlk5vn8FJbk70O6" -H "Content-Type: application/json"

Response Status Code

Status Code Description
200 OK 성공
400 Bad Request 클라이언트 요청 오류 - user_key, code가 빈값일 때
403 Forbidden x-api-key 인증 에러
403 Forbidden URL 경로, HTTP method 오류
422 Unprocessable Entity 형식에 맞지 않는 강의 코드, 메모 타입을 요청 했을 때
422 Unprocessable Entity 데이터 삭제시 없는 데이터를 삭제하려 할 때
500 Internal Server Error 서버에 문제가 있을 경우

주의 사항

cURL 한글 깨짐 현상

windows의 콘솔창은 기본 cp949 형식이며, utf-8 인코딩의 한글은 출력할 시에 깨지게 됩니다. 아래를 통해 한글 깨짐을 방지할 수 있습니다.

  1. 콘솔창을 호출하여 우클릭 > 속성 을 호출합니다.
  2. 글꼴탭에서 글꼴을 굴림체로 변경합니다.

    ※ 굴림체로 변경안하고 utf-8로 변경시 글꼴이 엄청 작아집니다.

  3. 커맨드라인에 아래와 같이 입력합니다. ( utf-8(65001)로 변경 )

    chcp 65001

  4. 한글 결과가 나오는 rest url을 호출하면 정상적으로 호출되는 것을 확인하실 수 있습니다.

cURL queryparam 요청시

개발 루트

  • 개발은 AWS DynamoDB, AWS Lambda, AWS API Gateway, AWS S3를 사용하여 개발
  1. 강좌 데이터는 목록을 csv파일로 만들어 S3 버킷에 csv을 올린 뒤 Lambda 함수로 버킷에 있는 데이터를 로드해 DynamoDB 테이블에 데이터 저장
  2. API Gateway는 Lambda-proxy 타입으로 생성 - URL Method 별로 Lambda 함수를 분리하지 않고 하나의 Lambda 함수로 통합 관리 하도록
  3. 요청이 들어온 resource 별로, httpmethod 별로 각각 조건을 나누어 요청이 들어오면 해당 조건에 맞는 이벤트를 처리
  4. aws-sdk로 DynamoDB 연동 후 조회(query, scan), 추가(put), 삭제(delete) 기능을 구현

About

AWS Lambda를 사용한 강좌관리 REST API

Topics

aws aws-s3 aws-sdk boto3 aws-dynamodb aws-gateway-api aws-lambda-api lambda-server

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages