Skip to content

๐Ÿ›œ API Docs

KyungMin Lee edited this page Aug 28, 2024 · 1 revision

Project API

ํ”„๋กœ์ ํŠธ ์ •๋ณด ์กฐํšŒ

  • Method: GET
  • URI: /v1/projects/{projectId}

Path Parameters

Parameter Type Description
projectId Long ํ”„๋กœ์ ํŠธ ID

Response

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "id": 100,
    "name": "My First Project",
    "createdAt": "2023-08-10T08:00:00Z",
    "updatedAt": "2023-08-22T11:30:00Z"
  }
}

ํ”„๋กœ์ ํŠธ ์ƒ์„ฑ

  • Method: POST
  • URI: /v1/projects

Request Body

{
  "name": "New Project"
}

Response

{
  "statusCode": 201,
  "message": "Success",
  "data": {
    "id": 101,
    "name": "New Project",
    "createdAt": "2023-08-22T15:00:00Z",
    "updatedAt": "2023-08-22T15:00:00Z"
  }
}

ํ”„๋กœ์ ํŠธ ์ •๋ณด ์ˆ˜์ •

  • Method: PUT
  • URI: /v1/projects/{projectId}

Path Parameters

Parameter Type Description
projectId Long ํ”„๋กœ์ ํŠธ ID

Request Body

{
  "name": "Updated Project Name"
}

Response

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "id": 100,
    "name": "Updated Project Name",
    "createdAt": "2023-08-10T08:00:00Z",
    "updatedAt": "2023-08-22T16:30:00Z"
  }
}

ํ”„๋กœ์ ํŠธ ์‚ญ์ œ

  • Method: DELETE
  • URI: /v1/projects/{projectId}

Path Parameters

Parameter Type Description
projectId Long ํ”„๋กœ์ ํŠธ ID

Response

{
  "statusCode": 200,
  "message": "Success",
  "data": 101
}

App API

ํ”„๋กœ์ ํŠธ ์•ฑ ๋ชฉ๋ก ์กฐํšŒ

  • Method: GET
  • URI: /v1/projects/{projectId}/apps

Path Parameters

Parameter Type Description
projectId Long ํ”„๋กœ์ ํŠธ ID

Response

{
  "statusCode": 200,
  "message": "Success",
  "data": [
    {
      "id": 1,
      "projectId": 100,
      "name": "My Web App",
      "appType": "WEB",
      "token": "abc123def456",
      "createdAt": "2023-08-15T10:30:00Z"
    },
    {
      "id": 2,
      "projectId": 100,
      "name": "My Mobile App",
      "appType": "MOBILE",
      "token": "ghi789jkl012",
      "createdAt": "2023-08-16T14:45:00Z"
    }
  ]
}

ํŠน์ • ์•ฑ ์ •๋ณด ์กฐํšŒ

  • Method: GET
  • URI: /v1/projects/{projectId}/apps/{appId}

Path Parameters

Parameter Type Description
projectId Long ํ”„๋กœ์ ํŠธ ID
appId Long ์•ฑ ID

Response

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "id": 1,
    "projectId": 100,
    "name": "My Web App",
    "appType": "WEB",
    "token": "abc123def456",
    "createdAt": "2023-08-15T10:30:00Z"
  }
}

์•ฑ ์ƒ์„ฑ

  • Method: POST
  • URI: /v1/projects/{projectId}/apps

Path Parameters

Parameter Type Description
projectId Long ํ”„๋กœ์ ํŠธ ID

Request Body

{
  "name": "New Test App",
  "appType": "SERVER"
}

Response

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "id": 3,
    "projectId": 100,
    "name": "New Test App",
    "appType": "SERVER",
    "token": "mno345pqr678",
    "createdAt": "2023-08-22T09:00:00Z"
  }
}

์•ฑ ์‚ญ์ œ

  • Method: DELETE
  • URI: /v1/projects/{projectId}/apps/{appId}

Path Parameters

Parameter Type Description
projectId Long ํ”„๋กœ์ ํŠธ ID
appId Long ์•ฑ ID

Response

{
  "statusCode": 200,
  "message": "Success",
  "data": 3
}

๋กœ๊ทธ API

๋กœ๊ทธ ์ƒ์„ฑ

  • Method: POST
  • URI: /logs

Required Headers

Content-Type: application/json
App-Key: {appKey}

Request Body

{
  "logLevel": "INFO",
  "logData": "User logged in",
  "timestamp": "2023-06-13T14:30:00Z"
}

Response

Success

Status: 201 Created Body: None

Error Responses

400 Bad Request

  • ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ํ‚ค๊ฐ€ ๋ˆ„๋ฝ๋˜์—ˆ๊ฑฐ๋‚˜ ์œ ํšจํ•˜์ง€ ์•Š์€ ๊ฒฝ์šฐ
  • ์š”์ฒญ ๋ณธ๋ฌธ์˜ ํ•„๋“œ๊ฐ€ ์œ ํšจํ•˜์ง€ ์•Š์€ ๊ฒฝ์šฐ (์˜ˆ: ํ•„์ˆ˜ ํ•„๋“œ ๋ˆ„๋ฝ, ํ˜•์‹ ๋ถˆ์ผ์น˜ ๋“ฑ)

Notes

  • app-key๋Š” ์œ ํšจํ•œ ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ํ‚ค์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค.
  • logLevel๊ณผ logData๋Š” ๋น„์–ด์žˆ์ง€ ์•Š์•„์•ผ ํ•ฉ๋‹ˆ๋‹ค.
  • timestamp๋Š” ๋ฐ˜๋“œ์‹œ ์œ ํšจํ•œ ๋‚ ์งœ/์‹œ๊ฐ„ ํ˜•์‹์ด์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

๐Ÿงซ ํŒ€ ๋ฌธํ™”

โš™๏ธ ๊ตฌ์„ฑ

๐Ÿ”จ ๊ฐœ๋ฐœ ์œ„ํ‚ค

๐Ÿž Bug Report

๐Ÿงช Test Logs

Clone this wiki locally