API 문서

API 문서

공통

response status https://developer.mozilla.org/ko/docs/Web/HTTP/Status

accept: application/json

content-type: application/json

에러처리

{ message: "Something wrong" }

정상적으로 처리되지 않았을 경우 올바른 status code와 에러에 대한 메시지를 담은 json을 응답한다. reference

/api/auth/github/signin

post

parameter

{ code: string }

responses

cookie connect.sid cookie alarmToken

/api/auth/github/signup

post

parameter

{
    code: string,
    username: string,
    email: string
}

response

cookie connect.sid cookie alarmToken

/api/auth/signout

post

parameter

cookie connect.sid

response

cookie expired connect.sid

delete

paramiter

cookie connect.sid

response

cookie expired connect.sid

/api/stock/bid-ask

get

parameter

stockId

response

{
    askOrders: [],
    bidOrders: []
}

비고

askOrders는 가장 낮은 금액의 주문 10개, bidOrders는 가장 높은 금액의 주문 10개

/api/stock/log

get

parameter

code, start, end, type

response

{
    log: []
}

비고

type은 1이 ASK, 2가 BID start는 Greater then Equals, end는 Less then으로 적용

/api/user/balance

get

parameter

cookie connect.sid type, start, end

response

{
    balance: string,
    log: []
}

비고

type은 1이 ASK, 2가 BID start는 Greater then Equals, end는 Less then으로 적용

/api/user/balance/deposit

post

parameter

cookie connect.sid

{
    bank: string,
    bankAccount: string,
    changeValue: string
}

response

EMPTY

비고

changeValue는 0보다 크거나 같고 10,000,000 작거나 같아야 함

/api/user/balance/withdraw

post

parameter

cookie connect.sid

{
    bank: string,
    bankAccount: string,
    changeValue: string
}

response

EMPTY

비고

changeValue는 0보다 크거나 같고 10,000,000 작거나 같아야 함

/api/user/favorite

get

parameter

cookie connect.sid

response

{ favorite: [] }

post

parameter

cookie connect.sid

{ stockCode: string }

response

EMPTY

delete

parameter

cookie connect.sid

{ stockCode: string }

response

EMPTY

/api/user/hold

get

parameter

cookie connect.sid

response

{ holdStocks: [] }

/api/user/order

get

parameter

cookie connect.sid

{
    end: number,
    type: number
}

response

{ pendingOrder: [] }

비고

type은 1이 ASK, 2가 BID

post

parameter

cookie connect.sid

{
    stockCode: string,
    type: number,
    amount: number,
    price: number
}

response

EMPTY

비고

type은 1이 ASK, 2가 BID price는 0보다 크거나 같고 10,000,000,000 작거나 같아야 함 amount는 0보다 크거나 같고 10,000보다 작거나 같아야 함

delete

parameter

cookie connect.sid

{
    id: number,
    type: number
}

response

EMPTY

비고

type은 1이 ASK, 2가 BID id는 orderId를 의미한다.

/api/user

get

parameter

cookie connect.sid

response

{ user: User }

/api/user/email

get

parameter

email

response

{ result: boolean }

비고

사용할수 있으면 true

/api/user/order/bid-ask

get

parameter

stockId

response

{
    askOrders: [],
    bidOrders: []
}

비고

askOrders는 가장 낮은 금액의 주문 10개, bidOrders는 가장 높은 금액의 주문 10개

/api/user/transaction

get

parameter

cookie connect.sid type, start, end

response

{ log: [] }

비고

type은 1이 1분 로그, 1440은 1일 로그

메모 https://google.github.io/styleguide/jsoncstyleguide.xml

https://www.ibm.com/docs/en/urbancode-build/6.1.2?topic=reference-rest-api-conventions

https://github.com/omniti-labs/jsend