API docs by Redocly

SMUNITY API (v2.4.0 (dd4549d))

Download OpenAPI specification:Download

상명대학교 졸업요건 검사 사이트 API 명세서

01 Account API

계정 관련 API

회원가입

회원 정보를 바탕으로 회원을 등록합니다.

Authorizations:
access-token
Request Body schema: application/json
username
required
string^\d{9}$
password
required
string [ 8 .. 2147483647 ] characters
email
required
string^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2...
name
required
string
department
required
string
secondDepartment
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "stringst",
  • "email": "string",
  • "name": "string",
  • "department": "string",
  • "secondDepartment": "string"
}

토큰 갱신

리프레시 토큰을 통해 액세스 토큰과 리프레시 토큰을 재발급합니다.

Authorizations:
access-token
Request Body schema: application/json
refreshToken
required
string

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

로그아웃

동일 사용자 검증 후 리프레시 토큰을 무효화합니다.

Authorizations:
access-token
Request Body schema: application/json
refreshToken
required
string

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

로그인

사용자의 로그인 정보를 검증하고 액세스 토큰과 리프레시 토큰을 반환합니다.

Authorizations:
access-token
Request Body schema: application/json
username
required
string
password
required
string [ 8 .. 2147483647 ] characters

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "stringst"
}

02 Auth API

인증 관련 API

사용자 인증

사용자 인증 요청을 검증하고 인증 토큰을 반환합니다.

Authorizations:
access-token
Request Body schema: application/json
username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

회원가입 사용자 인증

회원가입을 위한 사용자 인증 토큰을 반환합니다.

Authorizations:
access-token
Request Body schema: application/json
username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

비밀번호 재설정 사용자 인증

사용자의 비밀번호 재설정을 위한 사용자 인증 토큰을 반환합니다.

Authorizations:
access-token
Request Body schema: application/json
username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

03 Member API

회원 관련 API

내 정보 조회

로그인한 회원의 정보를 조회합니다.

Authorizations:
access-token

Responses

내 정보 수정

로그인한 회원의 정보를 수정합니다.

Authorizations:
access-token
Request Body schema: application/json
username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

내 계정 삭제

로그인한 회원의 계정을 삭제합니다.

Authorizations:
access-token

Responses

비밀번호 재설정

인증 토큰 검증 후 비밀번호를 변경합니다.

Authorizations:
access-token
Request Body schema: application/json
password
required
string [ 8 .. 2147483647 ] characters

Responses

Request samples

Content type
application/json
{
  • "password": "stringst"
}

비밀번호 변경

로그인한 회원의 비밀번호를 변경합니다.

Authorizations:
access-token
Request Body schema: application/json
password
required
string [ 8 .. 2147483647 ] characters

Responses

Request samples

Content type
application/json
{
  • "password": "stringst"
}

이수 면제 설정 변경

로그인한 회원의 이수 면제 설정을 변경합니다.

Authorizations:
access-token
Request Body schema: application/json
exemption
string
Enum: "FOREIGN" "DISABLED" "TRANSFER"

Responses

Request samples

Content type
application/json
{
  • "exemption": "FOREIGN"
}

학과 변경

로그인한 회원의 학과를 변경합니다.

Authorizations:
access-token
Request Body schema: application/json
departmentId
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "departmentId": 0
}

회원 목록 조회

회원 목록을 페이징 처리하여 조회합니다.

Authorizations:
access-token
query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

회원 수 조회

전체 회원 수를 조회합니다.

Authorizations:
access-token

Responses

04 Department API

학과 관련 API

학과 조회

전체 학과 목록을 조회합니다.

Authorizations:
access-token

Responses

수정 가능한 학과 조회

수정 가능한 학과 목록을 조회합니다.

Authorizations:
access-token

Responses

05 Course API

이수과목 관련 API

이수과목 업로드

로그인한 회원의 이수과목을 업로드합니다.

Authorizations:
access-token
Request Body schema: application/json
username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

이수과목 조회

이수구분을 기준으로 로그인한 회원의 이수과목 목록을 조회합니다.

Authorizations:
access-token
query Parameters
category
string
Enum: "MAJOR_ADVANCED" "MAJOR_OPTIONAL" "FIRST_MAJOR" "SECOND_MAJOR" "CULTURE" "ETC"

Responses

이수 교양과목 강의 조회

교양 이수구분을 기준으로 로그인한 회원의 이수 교양과목 목록을 조회합니다.

Authorizations:
access-token
path Parameters
domain
required
string
Enum: "BASIC" "CORE" "BALANCE"

Responses

이수과목 학점 조회

로그인한 회원의 이수과목 학점을 조회합니다.

Authorizations:
access-token

Responses

06 Major API

전공과목 관련 API

전공과목 목록 조회

이수구분을 기준으로 로그인한 회원이 이수하지 않은 전공과목 목록을 조회합니다.

Authorizations:
access-token
query Parameters
category
string
Enum: "MAJOR_ADVANCED" "MAJOR_OPTIONAL" "FIRST_MAJOR" "SECOND_MAJOR" "CULTURE" "ETC"

Responses

07 Culture API

교양과목 관련 API

교양과목 목록 조회

교양 영역을 기준으로 교양과목 목록을 조회합니다.

Authorizations:
access-token
query Parameters
subDomain
string
Enum: "BASIC_ACCIDENT" "BASIC_ENG_MATH" "BASIC_COMPUTER_1" "BASIC_COMPUTER_2" "BASIC_COMPUTER" "CORE_PROFESSIONAL" "CORE_CREATIVE" "CORE_CONVERGENCE" "CORE_DIVERSITY" "CORE_ETHICAL" "BALANCE_HUMANITIES" "BALANCE_SOCIAL" "BALANCE_NATURAL" "BALANCE_ENGINEER" "BALANCE_ART" "BALANCE_BRIDGE" "BALANCE_NATURAL_ENGINEER"

Responses

08 Question API

질문 관련 API

질문 조회

질문을 조회합니다.

Authorizations:
access-token
path Parameters
questionId
required
integer <int64>

Responses

질문 수정

로그인한 회원이 본인이 작성한 질문을 수정합니다.

Authorizations:
access-token
path Parameters
questionId
required
integer <int64>
Request Body schema: application/json
title
required
string
content
required
string
anonymous
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "content": "string",
  • "anonymous": true
}

질문 삭제

로그인한 회원이 본인이 작성한 질문을 삭제합니다.

Authorizations:
access-token
path Parameters
questionId
required
integer <int64>

Responses

질문 목록 조회

질문 목록을 페이징 처리하여 조회합니다.

Authorizations:
access-token
query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 5

The size of the page to be returned

sort
Array of strings
Default: ["createdAt,DESC"]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

질문 생성

로그인한 회원으로 질문을 생성합니다.

Authorizations:
access-token
Request Body schema: application/json
title
required
string
content
required
string
anonymous
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "content": "string",
  • "anonymous": true
}

09 Answer API

답변 관련 API

답변 조회

질문에 대한 답변을 조회합니다.

Authorizations:
access-token
path Parameters
questionId
required
integer <int64>

Responses

답변 수정

관리자가 질문에 대한 답변을 수정합니다.

Authorizations:
access-token
path Parameters
questionId
required
integer <int64>
Request Body schema: application/json
content
required
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

답변 생성

관리자가 질문에 대한 답변을 생성합니다.

Authorizations:
access-token
path Parameters
questionId
required
integer <int64>
Request Body schema: application/json
content
required
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

답변 삭제

관리자가 질문에 대한 답변을 삭제합니다.

Authorizations:
access-token
path Parameters
questionId
required
integer <int64>

Responses

10 Term API

학기 관련 API

현재 학기 조회

현재 학기를 조회합니다.

Authorizations:
access-token

Responses