API docs

API 문서

프로젝트에 사용하는 API 문서

API 문서 제작 가이드라인

API 대 분류

/url 경로

API의 기능에 대한 짤막한 설명

method : get, post
request : {
    body : {
        key1 : value1 (type1)
        key2 : value2 (type2)
    }
}
response : {
    body : {
        key1 : value1 (type1)
        key2 : value2 (type2)
    }
    redirect : route1 || route2 || route3
}

API 설명에 대한 자세한 설명

설명

method : api 요청을 어디로 해야 하는지

body : request에서 들어오는 body 객체, response에 send하는 객체에 대한 설명. 데이터를 여러개 가질 경우 키, 값, 타입을 기술한다.

redirect : api에서 redirect 시키는 경우를 기술. 자세한 설명은 본문에 기술한다.