테스트 사이트 - 개발 중인 베타 버전입니다

RESTFUL API Doc - 사인인/로그인 등

· 4년 전 · 1183

https://sir.kr/so_app/1914에 이어서 

 

접미는 /api/v1 식으로 합니다.  v1은 버전 v1.1 또는 v2식으로.

단 서브도메인이 가능하다면 api.도메인.com/v1으로 접속도 가능합니다.

 

1. Registration 

POST /users. or /members

 

[code]

{
  "user":{                     /* g5_member */
    "username": "test",        /* mb_id */
    "email": "test@test.com",  /* mb_email */
    "password": "test1234",    /* mb_password */
    "confirm_password": "test1234",
    "firstname": "테스트",     /* mb_name */
    "lastname": "",
    "nickname": "테스트"       /* mb_nick */
  }
}

[/code]

 

 

2. Login

POST /users/login

[code]

{
  "user":{                     /* g5_member */
    "username": "test",        /* mb_id */
    "password": "test1234",    /* mb_password */
  }
}

[/code]

 

3. Logout

POST /users/logout

[code]

{
  "user":{                     /* g5_member */
    "username": "test",        /* mb_id */
    "password": "test1234",    /* mb_password */
  }
}

[/code]

 

4. Update User: 인증 필요(토큰 필요)

[code]

{
  "user":{                        /* g5_member */
    "username": "test",           /* mb_id */
    "cellphone": "test@test.com", /* mb_hp */
    "birthdate": "2020/12/20",    /* mb_birth */
    "homepage": "www.sir.kr",     /* mb_homepage */
    "gender": "남",               /* mb_sex */
    "memo": "",                   /* mb_memo */
    "nickname": "테스트"          /* mb_nick */
  }
}

[/code]

 

REST API를 원하시는 분들의 의견을 듣고 싶습니다.

 

보통은 필드 네임으로 넘어 오는 것이 이해하기도 편하긴 한데,  위와 같이 범용성을 감안하면 어떨지요?

 

 

 

 

댓글 작성

댓글을 작성하시려면 로그인이 필요합니다.

로그인하기

게시글 목록

번호 제목
2024
2019
2015
2011
2009
2005
1992
1987
1986
1984
1982
1970
1967
1966
1962
1948
1947
1944
1942
1938
1936
1932
1931
1928
1926
1914
1913
1901
1896
1893