API 설계 검토 및 수정 요청

[sodam-run-dev]

1. 전체 코인 목록 조회

• 엔드포인트: GET /api/coins
• 설명: default는 전체 코인 목록 조회하고, 관심 또는 보유 중인 코인으로 필터링하여 조회할 수 있어야 합니다.

요청 파라미터:

• limit (optional): 가져올 코인의 수 (예: limit=20)
• sortBy (optional): 코인을 정렬할 기준 (예: sortBy=market_cap)
• filter (optional):
  • favorite: 관심 코인만 필터링
  • owned: 보유한 코인만 필터링

요청 예시:

GET /api/coins?filter=favorite&limit=20

응답 형식:

coingecko 형식에 따름.

[
  {
    "id": "btc",
    "name": "Bitcoin",
    "symbol": "BTC",
    "price": 30000,
    "market_cap": 600000000000,
    "change_24h": 2.5
  },
  {
    "id": "eth",
    "name": "Ethereum",
    "symbol": "ETH",
    "price": 2000,
    "market_cap": 300000000000,
    "change_24h": -1.2
  }
]

---

2. 특정 코인 상세 정보 조회

• 엔드포인트: GET /api/coins/:id
• 설명: 특정 코인의 상세 정보를 조회하는 API입니다.

요청 예시:

GET /api/coins/btc

응답 형식:

coingecko 형식에 따름.

{
  "id": "btc",
  "name": "Bitcoin",
  "symbol": "BTC",
  "price": 30000,
  "market_cap": 600000000000,
}

---

3. 코인 거래 (구매/판매)

• 엔드포인트: POST /api/coins/:id/trade
• 설명: 특정 코인구매 또는 판매 하는 API

요청 예시:

POST /api/coins/btc/trade

{
  "action": "buy",|| "sell"
  "amount": 1.5,
  "price": 30000
}

응답 형식:

{
  "success": true,
  "message": "",
  "trade_history": [
    {
      "id": 1,
      "coin_id": "btc",
      "action": "buy",
      "amount": 1.5,
      "price": 30000,
      "timestamp": "2024-01-02T15:30:00Z"
    }
  ]
}

---

4. 내 자산 조회

• 엔드포인트: GET /api/user/assets
• 설명: 사용자가 보유한 자산을 조회하는 API입니다. 홈, 프로필에서 사용될 예정입니다 .

요청 예시:

GET /api/user/assets

응답 형식:

{
  "total_balance": 50000,
  "total_profit_loss": 5000,
  "assets": [
    {
      "id": "btc",
      "name": "Bitcoin",
      "amount": 1.5,
      "current_price": 30000,
      "total_value": 45000,
      "profit_loss": 3000
    },
    {
      "id": "eth",
      "name": "Ethereum",
      "amount": 2,
      "current_price": 2000,
      "total_value": 4000,
      "profit_loss": -1000
    }
  ]
}

---

5. 관심 코인 즐겨찾기

• 엔드포인트: POST /api/user/favorites
• 설명: 사용자가 관심 있는 코인을 추가하거나 삭제하는 API입니다. 코인 리스트와 상세페이지에 사용할 예정입니다.

요청 예시:

POST /api/user/favorites

{
  "coin_id": "btc",
  "action": "add" // 또는 "remove"?
}

---

6. 거래 내역 조회

• 엔드포인트: GET /api/user/trade-history
• 설명: 사용자의 거래 내역을 조회하는 API입니다.

요청 예시:

GET /api/user/trade-history

응답 형식:

TODO

---

7. 상세 > 코인 가격 조회 (차트 데이터)

• 엔드포인트: GET /api/coins/:id/price-history
• 설명: 일정 기간 동안 코인의 가격 변동 기록을 조회하여 차트 그릴 때 사용됩니다.

• 요청 예시:

GET /api/coins/btc/price-history?period=1d

응답 형식:

TODO

---

[sodam-run-dev]

멘토님, API 리스트 작성해보았습니다. 일부 내용이 부족하거나 수정이 필요한 부분이 있을 수 있어 검토 부탁드릴게요~~ 개선 필요한 부분은 코멘트 남겨주시거나 자유롭게 수정해주시면 감사하겠습니다.