API(V1) - daehyun99/Translate-app GitHub Wiki

graph TD;
    Front["Front-End"] <--> |"API(V1)"| Back-End["Back-End"]
Loading
  • Front-End와 Back-End μ—°κ²° 정보 λ¬Έμ„œ
  • Request, Response ꡬ쑰 및 ν˜•νƒœ μ •μ˜

Request, Response ꡬ쑰 및 ν˜•νƒœ

Request

  • Success Request Body
{
    "status": f"{StatusCode}",
    "msg": "βœ… SuccessRequest",
    "error": None,
    "data": {
        "key1": "value1",
        "key2": "value2",
        ...
        "keyN": "valueN"
    }
}

Response

  • Success Response Body
{
    "status": f"{StatusCode}",
    "msg": "βœ… SuccessResponse",
    "error": None,
    "data": {
        "key1": "value1",
        "key2": "value2",
        ...
        "keyN": "valueN"
    }
}
  • Fail Response Body
{
    "status": f"{StatusCode}",
    "msg": "πŸ›‘ FailResponse",
    "error": None,
    "data": None
}
  • Error Response Body
{
    "status": f"{StatusCode}",
    "msg": "❌ ErrorResponse",
    "error": {
        "code": f"{StatusCode}{Service}{DetailCode}",
        "ex": f"{ex}"
    },
    "data": None
}
⚠️ **GitHub.com Fallback** ⚠️