thinkphp5開發restful-api接口學習 教程視頻 接口文檔

目錄

• 1. 獲取驗證碼
• 2. 用戶註冊
• 3. 用戶登陸
• 4. 用戶上傳頭像
• 5. 用戶修改密碼
• 6. 用戶找回密碼
• 7. 用戶綁定手機號
• 8. 用戶綁定郵箱
• 9. 用戶綁定用戶名(手機/郵箱)
• 10. 用戶設定暱稱
• 11. 新增文章
• 12. 查看文章列表
• 13. 查看單個文章信息
• 14. 修改/保存文章
• 15. 刪除文章

1. 獲取驗證碼

get api.tp5.com/code

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
username	string	必需	無	手機號或者郵箱
is_exist	int	必需	無	用戶名是否應該存在(1:是 0:否)

{
    "code": 200,
    "msg": "手機驗證碼已經發送成功, 天天能夠發送5次, 請在一分鐘內驗證!",
    "data": []
}

---

2. 用戶註冊

post api.tp5.com/user/register

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
user_name	string	必需	無	手機號或者郵箱
user_pwd	string	必需	無	md5加密的用戶密碼
code	int	必需	無	用戶收到的驗證碼

{
    "code": 200,
    "msg": "註冊成功!",
    "data": []
}

---

3. 用戶登陸

post api.tp5.com/user/login

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
user_name	string	必需	無	手機號或者郵箱
user_pwd	string	必需	無	md5加密的用戶密碼

{
    "code": 200,
    "msg": "登陸成功!",
    "data": {
        'user_id':1, // 用戶id
        'user_phone':'15639279530', // 用戶手機號
        'user_name':'', // 用戶暱稱
        'user_email':'', // 用戶郵箱
        'user_rtime':1501414343 // 用戶註冊時間
    }
}

---

4. 用戶上傳頭像

post api.tp5.com/user/icon

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
user_id	int	必需	無	用戶id
user_icon	file	必需	無	用戶頭像(默認 200*200)

{
    "code": 200,
    "msg": "上傳頭像成功!",
    "data": "/uploads/20170801/71225b61d9ae892db2dc99dac9eee752.jpg"
}

---

5. 用戶修改密碼

post api.tp5.com/user/change_pwd

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
user_name	string	必需	無	用戶名(手機/郵箱)
user_ini_pwd	string	必需	無	用戶的老密碼
user_pwd	string	必需	無	用戶的新密碼

{
    "code": 200,
    "msg": "密碼修改爲功!",
    "data": []
}

---

6. 用戶找回密碼

post api.tp5.com/user/find_pwd

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
user_name	string	必需	無	用戶名(手機/郵箱)
code	string	必需	無	驗證碼
user_pwd	string	必需	無	用戶的新密碼

{
    "code": 200,
    "msg": "密碼修改爲功!",
    "data": []
}

---

7. 用戶綁定手機號

post api.tp5.com/user/bind_phone

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
user_id	int	必需	無	用戶id
code	string	必需	無	驗證碼
phone	string	必需	無	用戶的手機號

{
    "code": 200,
    "msg": "手機號綁定成功!",
    "data": []
}

---

8. 用戶綁定郵箱

post api.tp5.com/user/bind_email

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
user_id	int	必需	無	用戶id
code	string	必需	無	驗證碼
email	string	必需	無	用戶的郵箱

{
    "code": 200,
    "msg": "郵箱綁定成功!",
    "data": []
}

---

9. 用戶綁定用戶名(手機/郵箱)

post api.tp5.com/user/bind_email

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
user_id	int	必需	無	用戶id
code	string	必需	無	驗證碼
user_name	string	必需	無	用戶的郵箱

{
    "code": 200,
    "msg": "郵箱綁定成功!",
    "data": []
}

---

10. 用戶設定暱稱

post api.tp5.com/user/nickname

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
user_id	int	必需	無	用戶id
user_nickname	string	必需	無	用戶暱稱

{
    "code": 200,
    "msg": "暱稱修改爲功!",
    "data": []
}

---

11. 新增文章

post api.tp5.com/article

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
article_uid	int	必需	無	文章用戶id
article_title	string	必需	無	文章標題

{
    "code": 200,
    "msg": "新增文章成功!",
    "data": "3" // 文章id
}

---

12. 查看文章列表

get api.tp5.com/articles

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
user_id	int	必需	無	用戶id
num	int	非必須	10	每頁個數
page	int	非必須	1	頁碼

{
    "code": 200,
    "msg": "查詢成功!",
    "data": {
        "articles": [
            {
                "article_id": 20, // 文章id
                "article_ctime": 1501756190, // 文章建立時間
                "article_title": "test_title", // 文章標題
                "user_name": "red_panda" // 文章做者暱稱(user_nickname)
            },
            {
                "article_id": 21, // 文章id
                "article_ctime": 1501758668, // 文章建立時間
                "article_title": "<script>test_title</script>", // 文章標題
                "user_name": "red_panda" // 文章做者暱稱(user_nickname)
            }
        ],
        "page_num": 3 // 文章列表總頁數(根據每頁條數實時計算)
    }
}

---

13. 查看單個文章信息

get api.tp5.com/article

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
article_id	int	必需	無	文章id

{
    "code": 200,
    "msg": "獲取成功!",
    "data": {
        "article_id": 1,  // 文章id
        "article_title": "test_title", // 文章標題
        "article_ctime": 1501756084, // 文章建立時間
        "article_content": "<script>alert('fuck');</script>", // 文章內容
        "user_name": "red_panda" // 文章做者暱稱(user_nickname)
    }
}

---

14. 修改/保存文章

put api.tp5.com/article

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
article_id	int	必需	無	文章id

{
    "code": 200,
    "msg": "文章更新成功!",
    "data": []
}

---

15. 刪除文章

delete api.tp5.com/article

參數	類型	必需/可選	默認	描述
time	int	必需	無	時間戳(用於判斷請求是否超時)
token	string	必需	無	肯定來訪者身份
article_id	int	必需	無	文章id

{
    "code": 200,
    "msg": "文章刪除成功!",
    "data": []
}