REST API¶

개요¶

그누보드6에서는 데이터를 외부에서 읽고 쓸 수 있도록 API를 제공합니다.
설치 후에는 간단한 설정을 통해 바로 사용할 수 있습니다.

인증 (Authentication)¶

그누보드6 REST API는 보안을 위해 OAuth 2.0 인증 방식을 사용합니다.
권한이 필요한 API 요청 시, Authorization 헤더에 액세스 토큰을 포함해야 합니다.

Authorization: Bearer {access_token}

액세스 토큰 (Access Token)¶

액세스 토큰은 사용자 인증 후 발급되며, API 호출 시 필요한 권한을 부여합니다.
토큰은 유효 기간이 있으며, 만료 시 재발급이 필요합니다.

리프레시 토큰 (Refresh Token)¶

리프레시 토큰은 액세스 토큰이 만료되었을 때 새로운 액세스 토큰을 발급받기 위해 사용됩니다. 리프레시 토큰은 비교적 긴 유효 기간을 가지며, 데이터베이스에 저장됩니다.
별도의 엔드포인트를 통해 새로운 액세스 토큰을 요청할 수 있습니다. (리프레시 토큰도 함께 갱신됩니다.)

요청 (Request)¶

각 엔드포인트에 대한 요청 형식은 다음과 같습니다.

• 헤더(Header): Authorization: Bearer {access_token}
• 파라미터(Parameters): 쿼리 스트링 또는 URL 파라미터.
• 바디(Body): JSON 형식의 데이터.

응답 (Response)¶

본문 (Body)¶

파일 다운로드를 제외한 응답의 기본 형식은 JSON으로 응답합니다. 에러 발생 시에도 에러 메시지를 동일한 형식으로 응답합니다.

// 성공
{
  "categories": [
    "string"
  ],
  "board": {
    "bo_table": "string",
    "gr_id": "string",
    "bo_subject": "string",
    ...

// 에러
{
  "message": "string"
}

HTTP 상태 코드(Status Code)¶