Welcom to GoraeBang!

      -.     .-
        '. .'
          |
 ,-----.  |
: . .   `.|   .--.
|         `--'  .'
' '--'    ...   '.    
 `-----`'''   '-..'
-----------------------------------------------------------------

■ Server API Index

ver.0.0.2

( 2nd // updated_at: 2016-08-08 04:35:05 )

(0.0.1) 회원가입 (Finished_at: 2016-07-29)
(0.0.2) 로그인 (Finished_at: 2016-07-29)
(0.0.3-0) 회원데이터
(0.0.4-0) 로그아웃
(0.0.5-0) 실행 시 첫 화면
(0.0.6-0) 이 달의 신규 등록
(0.0.7-0) 검색(검색 엔진 연구)
(0.0.8-1) 마이리스트 create
(0.0.9-1) 마이리스트 read
(0.0.10-1) 마이리스트 update
(0.0.11-1) 마이리스트 delete
(0.0.12-1) 마이리스트 내부 노래 create
(0.0.13-1) 마이리스트 내부 노래 read
(0.0.14-1) 마이리스트 내부 노래 update
(0.0.15-1) 마이리스트 내부 노래 delete
(0.0.16-1) 노래 차단
(0.0.17-1) 차단된 노래 read
(0.0.18-1) 차단된 노래 delete(차단해제)
(0.0.19-0) 개인정보 변경
(0.0.20-0) 회원 탈퇴
(0.0.21-1) 음역검증된 노래 READ(임시적으로 만듬)

    "ver.A.B.C-D" 의 표현은 다음과 같다.
    A = A차 완성본
    B = B번째 모듈 또는 프로젝트
    C = C번째 세부기능
    D = D=0 if 미완성
        D=1 if 피드백대기
        D=2 if 피드백반영 후 완성대기
        D= none if 완성(Client에서 완벽히 동작하는 것을 확인할 것)

| 회원가입(0.0.1) |

요청(Request)

Method: 'POST'
Url: "/json/regist"

예제(Example)

to GET method example

http://api.goraebang.com/json/regist?user[email]=이메일&user[name]=이름&user[gender]=성별(숫자0=표기안함, 1=남자, 2=여자)&user[password]=패스워드&user[password_confirmation]=패스워드확인&authNum=인증코드

매개변수(Parameters)

key	value	desc
user[email]	사용자 이메일	필수, 이메일 양식
user[name]	사용자 닉네임	필수
user[password]	패스워드	필수, 6자이상의 문자+숫자
user[password_confirmation]	패스워드 확인	필수, 패스워드 값과 동일
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json'
Read : {"result" : 성공여부, "id": 가입한 회원 id(고유식별자)}
- 성공 ex) {"result":"SUCCESS", "id":"1"}
- 실패 ex) {"result":"ERROR", "id":"ERROR"}
성공 요건
1. 가입자 이메일이 기존 회원과 중복되지 않을 때
2. 패스워드와 패스워드 확인 문자열이 일치할 때

| 로그인(0.0.2) |

요청(Request)

Method: 'POST'
Url: "/json/login"

예제(Example)

to GET method example

http://api.goraebang.com/json/login?user[email]=이메일&user[password]=패스워드&authNum=인증코드'

매개변수(Parameters)

key	value	desc
user[email]	사용자 이메일	필수, 이메일 양식
user[password]	패스워드	필수, 6자이상의 문자+숫자
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json'
Read : {"result" : 성공여부, "id": 가입한 회원 id(고유식별자)}
- 성공 ex) {"result":"SUCCESS", "id":"1"}
- 실패 ex) {"result":"ERROR", "id":"ERROR"}
성공 요건
1. 접속자 이메일이 회원DB 내에 존재할 때 (탈퇴하지 않은 가입자)
2. 접속자 이메일과 패스워드가 DB상의 것과 일치할 때 (계정확인)

| 회원데이터(0.0.3-0) |

| 마이리스트 CREATE(0.0.8-1) |

요청(Request)

Method: 'POST'
Url: "/json/myList_create"

예제(Example)

to GET method example

http://api.goraebang.com/json/myList_create?id=회원ID&title=myList타이틀&authNum=인증코드'

매개변수(Parameters)

key	value	desc
id	사용자 레코드 id값	필수
title	myList 타이틀	필수, 조건없음
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json'
Read : {"id": 가입한 회원 id(고유식별자), "message" : 성공여부}
- 성공 ex) {"id":"1", "message":"SUCCESS"}
- 실패 ex) {"id":"ERROR", "message":"ERROR"}
성공 요건
1. 파라미터가 전부 존재할 때 (통신상태만 CHECK)

| 마이리스트 READ(0.0.9-1) |

요청(Request)

Method: 'POST'
Url: "/json/myList_read"

예제(Example)

to GET method example

http://api.goraebang.com/json/myList_read?id=회원ID&authNum=인증코드'

매개변수(Parameters)

key	value	desc
id	사용자 레코드 id값	필수
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json DATA-SET'
Read : [{"id": 마이리스트 id(고유식별자), "title": 마이리스트 타이틀}...{}]
성공 요건
1. 가입된 회원

| 마이리스트 UPDATE(0.0.10-1) |

요청(Request)

Method: 'POST'
Url: "/json/myList_update"

예제(Example)

to GET method example

http://api.goraebang.com/json/myList_update?id=회원ID&myList_id=수정할myListID&title=수정할myList타이틀&authNum=인증코드'

매개변수(Parameters)

key	value	desc
id	사용자 레코드 id값	필수
myList_id	myList id값	필수
title	수정할 타이틀	필수, 조건없음
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json'
Read : {"id": 변경된 myList id(고유식별자), "message" : 성공여부}
- 성공 ex) {"id":"1", "message":"SUCCESS"}
- 실패 ex) {"id":"1", "message":"ERROR"}
성공 요건
1. 파라미터가 전부 존재할 때 (통신상태만 CHECK)
2. 요청한 리스트가 내 계정에 존재하는 리스트가 맞을 때

| 마이리스트 DELETE(0.0.11-1) |

요청(Request)

Method: 'POST'
Url: "/json/myList_delete"

예제(Example)

to GET method example

http://api.goraebang.com/json/myList_delete?id=회원ID&myList_id=삭제하려는myListID&authNum=인증코드'

매개변수(Parameters)

key	value	desc
id	사용자 레코드 id값	필수
myList_id	삭제하려는myList ID	필수
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json DATA-SET'
Read : [{"id": 마이리스트 id(고유식별자), "title": 마이리스트 타이틀}...{}]
성공 요건
1. 파라미터가 전부 존재할 때 (통신상태만 CHECK)
2. 요청한 리스트가 내 계정에 존재하는 리스트가 맞을 때

| 마이리스트 내부 노래 CREATE(0.0.12-1) |

요청(Request)

Method: 'POST'
Url: "/json/mySong_create"

예제(Example)

to GET method example

http://api.goraebang.com/json/mySong_create?id=회원ID&myList_id=소속될myListID&song_id=추가할songID&hometown=출처&authNum=인증코드'

매개변수(Parameters)

key	value	desc
id	사용자 레코드 id값	필수
myList_id	소속될myListID	필수
song_id	추가할songID	필수
hometown	출처(어느 페이지를 통해 마이스트에 들어왔는지)	필수
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json'
Read : {"id": 생성된 레코드 id(고유식별자), "message" : 성공여부}
- 성공 ex) {"id":"1", "message":"SUCCESS"}
- 실패 ex) {"id":"", "message":"ERROR"}
성공 요건
1. 파라미터가 전부 존재할 때 (통신상태만 CHECK)

| 마이리스트 내부 노래 READ(0.0.13-1) |

요청(Request)

Method: 'POST'
Url: "/json/mySong_read"

예제(Example)

to GET method example

http://api.goraebang.com/json/mySong_read?id=회원ID&myList_id=읽어들일myListID&authNum=인증코드'

매개변수(Parameters)

key	value	desc
id	사용자 레코드 id값	필수
myList_id	읽어들일 myList ID	필수
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json DATA-SET'
Read : [{"id": mySong 레코드 id(고유식별자), "mylist_id": 소속된 myList레코드 외래 키, "song_id": Song레코드의 외래 키}...{}]
성공 요건
1. 가입된 회원

| 마이리스트 내부 노래 UPDATE(0.0.14-1) |

요청(Request)

Method: 'POST'
Url: "/json/mySong_update"

예제(Example)

to GET method example

http://api.goraebang.com/json/mySong_update?id=회원ID&myList_id=현재소속된myListID&targetList_id=이동할myListID&mySong_id=수정하려는mySongID&authNum=인증코드'

매개변수(Parameters)

key	value	desc
id	사용자 레코드 id값	필수
myList_id	현재소속된 myList ID	필수
targetList_id	이동할 myList ID	필수
mySong_id	수정하려는 mySong ID	필수
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json'
Read : {"id": 변경된 mySong_id(고유식별자), "message" : 성공여부}
- 성공 ex) {"id":"1", "message":"SUCCESS"}
- 실패 ex) {"id":"1", "message":"ERROR"}
성공 요건
1. 파라미터가 전부 존재할 때 (통신상태만 CHECK)
2. 현재 소속 리스트와 이동할 타겟 리스트가 서로 다를 때

| 마이리스트 내부 노래 DELETE(0.0.15-1) |

요청(Request)

Method: 'POST'
Url: "/json/mySong_delete"

예제(Example)

to GET method example

http://api.goraebang.com/json/mySong_delete?id=회원ID&mySong_id=삭제하려는mySongID&authNum=인증코드'

매개변수(Parameters)

key	value	desc
id	사용자 레코드 id값	필수
mySong_id	삭제하려는 mySong ID	필수
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json DATA-SET'
Read : [{"id": mySong 레코드 id(고유식별자), "mylist_id": 소속된 myList레코드 외래 키, "song_id": Song레코드의 외래 키}...{}]
성공 요건
1. 파라미터가 전부 존재할 때 (통신상태만 CHECK)
2. 요청한 노래의 소속 리스트가 내 계정에 존재하는 리스트가 맞을 때

| 노래 차단(0.0.16-1) |

요청(Request)

Method: 'POST'
Url: "/json/blacklist_song_create"

예제(Example)

to GET method example

http://api.goraebang.com/json/blacklist_song_create?id=회원ID&song_id=차단하려는songID&authNum=인증코드'

매개변수(Parameters)

key	value	desc
id	사용자 레코드 id값	필수
song_id	차단하려는song ID	필수
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json'
Read : [{"id": 차단할 blacklistsong id(고유식별자), "message": 성공여부}...{}]
성공 요건
1. 파라미터가 전부 존재할 때 (통신상태만 CHECK)
2. 유저가 login 되어 있을 때

| 차단된 노래 READ(0.0.17-1) |

요청(Request)

Method: 'POST'
Url: "/json/blacklist_song_read"

예제(Example)

to GET method example

http://api.goraebang.com/json/blacklist_song_read?id=회원ID&authNum=인증코드'

매개변수(Parameters)

key	value	desc
id	사용자 레코드 id값	필수
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json DATA-SET'
Read : [{"result": 해당유저의 차단된 노래목록}...{}]
성공 요건
1. 파라미터가 전부 존재할 때 (통신상태만 CHECK)
2. 유저가 login 되어 있을 때

| 차단된 노래 DELETE(차단해제) (0.0.18-1) |

요청(Request)

Method: 'POST'
Url: "/json/blacklist_song_delete"

예제(Example)

to GET method example

http://api.goraebang.com/json/blacklist_song_delete?id=회원ID&id=blacklistsongID&authNum=인증코드'

매개변수(Parameters)

key	value	desc
id	사용자 레코드 id값	필수
id	blacklistsong id값	필수
authNum	인증코드	필수, 승인된 접속자를 식별

반환(RETURN)

Type: 'json DATA-SET'
Read : [{"result": 해당유저의 차단된 노래목록}...{}]
성공 요건
1. 파라미터가 전부 존재할 때 (통신상태만 CHECK)
2. 유저가 login 되어 있을 때

| 음역검증된 노래 READ(임시적으로 만듬) (0.0.21-1) |

요청(Request)

Method: 'POST'
Url: "/json/song"

예제(Example)

to GET method example

http://api.goraebang.com/json/song'

매개변수(Parameters)

반환(RETURN)

Type: 'json DATA-SET'
Read : [{"result": 음역대 측정이 완료된 노래목록}...{}]
성공 요건

Todo

[x]로그인
[ ]로그아웃
[ ]이달의 신곡페이지를 jQuery써가지고 구현해 보시오. 밑에 언더바가 잘 보이게! - Yong-Hyun Kim
[ ]....

Name		Name	Last commit message	Last commit date
Latest commit History 206 Commits
.idea		.idea
app		app
bin		bin
config		config
db		db
lib		lib
log		log
public		public
test		test
vendor/assets		vendor/assets
.gitignore		.gitignore
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
README.md		README.md
README.rdoc		README.rdoc
Rakefile		Rakefile
config.ru		config.ru
dump.rdb		dump.rdb
lab.rb		lab.rb
test.rb		test.rb

Folders and files

Latest commit

History

Repository files navigation

Welcom to GoraeBang!

﻿■ Server API Index

ver.0.0.2

| 회원가입(0.0.1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 로그인(0.0.2) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 회원데이터(0.0.3-0) |

| 마이리스트 CREATE(0.0.8-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 마이리스트 READ(0.0.9-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 마이리스트 UPDATE(0.0.10-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 마이리스트 DELETE(0.0.11-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 마이리스트 내부 노래 CREATE(0.0.12-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 마이리스트 내부 노래 READ(0.0.13-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 마이리스트 내부 노래 UPDATE(0.0.14-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 마이리스트 내부 노래 DELETE(0.0.15-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 노래 차단(0.0.16-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 차단된 노래 READ(0.0.17-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 차단된 노래 DELETE(차단해제) (0.0.18-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

| 음역검증된 노래 READ(임시적으로 만듬) (0.0.21-1) |

요청(Request)

예제(Example)

매개변수(Parameters)

반환(RETURN)

Todo

Information

■ Server API Index

Packages