band-api v1.0.1
band-api
설명
네이버 밴드 OPEN API 를 사용하여 밴드 OPEN API 를 더 간편하게 사용할 수 있도록 만들었습니다. (NPM 등록 X)
npm install band-api 으로 인스톨 후 require('band-api')으로 band-api를 불러옵니다.
밴드 목록이 성공적으로 불러와지면 require('band-api').app.bands 로 확인할 수 있습니다. 참고로, require('band-api').app.bands는 배열 형태로 저장됩니다.
만약 특정 밴드의 다음 게시글 목록을 불러오고 싶다면 require('band-api').nextPosts(callbackFunc, _bandIdxOrbandKey, _locale = 'ko-KR') 로 특정 밴드의 다음 게시글 목록을 불러올 수 있습니다. 마찬가지로 callbackFunc 파라미터는 밴드들의 게시글들을 불러오고 나서 호출되는 콜백함수 이며, 해당 콜백함수의 파타미터로는 err, key, item 이 있으며 key 은 밴드의 키값, item은 불러와진 게시글들의 데이터가 담겨져 있습니다.
_bandIdxOrbandKey 파라미터는 밴드 키값 또는 require('band-api').app.bands 배열의 인덱스를 넣으시면 됩니다. 만약, 서비스 할 밴드가 1개 뿐이라면 해당 파라미터 자리에 0 을 넣으시면 됩니다.
밴드들의 게시글들이 불러와지면 require('band-api').app.posts 로 정보를 확인할 수 있습니다. require('band-api').app.posts 는 require('band-api').app.bands 와는 다르게 Object 형식으로 저장되며 밴드의 키값을 이용하여 해당 밴드의 게시글 목록의 정보를 볼 수 있습니다.
밴드에서 게시글을 작성하시고 싶다면
require('band-api').createPost(callbackFunc, _bandIdxOrbandKey, _content, _doPush = false) 을
이용하시면 됩니다. callbackFunc 의 파라미터로는 err, bandKey, postKey 가 있으며 bandKey 는 게시글이 작성된 밴드의 키값이며 postKey 는 작성된 게시글의 키값 입니다.
_bandIdxOrbandKey 는 위와 마찬가지로 서비스 할 밴드가 1개 뿐이라면 해당 파라미터 자리에 0을 넣으시면 됩니다. _content 파라미터는 게시글의 내용을 적으시면 되며, _doPush 는 게시글 작성 시 푸시알림이 울리도록 할건지 정하는 파라미터이며 기본 값은 false 로 되어있습니다.
require('band-api').detailPost(callbackFunc, _bandIdxOrbandKey, _postIdxOrpostKey) 를 사용하시면 해당 밴드의 특정 게시글을 가져올 수 있습니다. callbackFunc 의 파라미터로는 err, bandKey, post 가 있으며 bandKey 는 게시글이 작성된 밴드의 키값이며 post 불러온 게시글의 정보가 담겨져있습니다.
_bandIdxOrbandKey 는 위와 마찬가지로 서비스 할 밴드가 1개 뿐이라면 해당 파라미터 자리에 0을 넣으시면 됩니다. _postIdxOrpostKey 파라미터는 해당 밴드의 특정한 게시글의 키값을 입력하시거나 0 에서부터 19 중 하나의 숫자를 입력하시면 require('band-api').app.posts내부에 해당 자리에 있는 게시글의 키값으로 변환됩니다.
특정한 게시글을 삭제하고 싶다면 require('band-api').removePost(callbackFunc, _bandIdxOrbandKey, _postIdxOrpostKey) 를 사용하면 됩니다. callbackFunc 의 파라미터로는 err 가 있습니다.
_bandIdxOrbandKey 는 위와 마찬가지로 서비스 할 밴드가 1개 뿐이라면 해당 파라미터 자리에 0을 넣으시면 됩니다. _postIdxOrpostKey 파라미터는 해당 밴드의 특정한 게시글의 키값을 입력하시거나 0 에서부터 19 중 하나의 숫자를 입력하시면 require('band-api').app.posts내부에 해당 자리에 있는 게시글의 키값으로 변환됩니다.
현재까지 구현한 기능들
- 밴드 목록 불러오기
- 밴드 게시글 불러오기
- 밴드의 다음 게시글 불러오기
- 게시글 삭제
- 게시글 보기
- 게시글 쓰기
앞으로 구현할 기능들