菜鳥朋友圈的相關介面介紹

若蘭__明月發表於2017-12-13
原文網址 : http://juejin.im/post/5a3109e16fb9a04522078115

BaseUrl

  • http://localhost:8080/api/

註冊介面(Post請求)

  • 介面 account/register
  • 引數
引數 引數解釋 是否為空
username 姓名 NO
phone 手機 NO
password 密碼 NO
  • 返回的結果形式
{
    "code": 1,
    "message": "ok",
    "time": "2017-08-19T23:27:20.558",
    "result": {
        "user": {
            "id": "56e5ef1f-2f99-48e7-a846-70c5a0007073",
            "name": "若蘭明月3",
            "phone": "13718989034",
            "password": null,
            "portrait": "http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg",
            "desc": null,
            "sex": 0
        },
        "account": "13718989034",
        "token": "YmI0YTA4ZWMtY2YwYy00ODI5LTk4N2UtMWI4MjA1ZTJjMTUx"
    }
}
複製程式碼

登入介面(Post請求)

  • 介面 account/login
  • 引數
引數 引數解釋 是否為空
phone 姓名 NO
password 密碼 NO
  • 返回的結果形式
{
    "code": 1,
    "message": "ok",
    "time": "2017-08-19T23:30:08.345",
    "result": {
        "user": {
            "id": "50cc22cf-9334-4e40-aa82-e9ca74de84ee",
            "name": "若蘭明月",
            "phone": "13718989054",
            "password": null,
            "portrait": "http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg",
            "desc": null,
            "sex": 0
        },
        "account": "13718989054",
        "token": "Nzk0NTVkOWMtYjg5Mi00OTgxLWExNzItMzA5NDUxNDFjZWMy"
    }
}
複製程式碼

發表動態介面(Post請求)

  • 介面 dynamic/publish
  • 引數
引數 引數解釋 是否為空
token 登入成功返回的token 這個要放到請求頭裡,伺服器端根據你的請求頭來判斷是否已經登入,可以做到單點登入 NO
publishId 使用者id NO
content 動態的文字內容 NO
pictures 動態的圖片 YES
  • 返回的結果形式
{
    "code": 1,
    "message": "ok",
    "time": "2017-08-19T23:35:07.858",
    "result": {
        "id": "2bc0ecb7-98de-403c-b330-de4a3a0566ce",
        "content": "完成了第一次釋出朋友圈的功能",
        "pictures": "[\"http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg\",\"http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg\",\"http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg\",\"http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg\"]",
        "createAt": null,
        "publishId": "56e5ef1f-2f99-48e7-a846-70c5a0007073",
        "user": {
            "id": "56e5ef1f-2f99-48e7-a846-70c5a0007073",
            "name": "若蘭明月3",
            "phone": "13718989034",
            "password": null,
            "portrait": "http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg",
            "desc": null,
            "sex": 0
        }
    }
}
複製程式碼

評論介面(Post請求)

  • 介面 dynamic/add/comment
  • 引數
引數 引數解釋 是否為空
token 登入成功返回的token放到請求頭裡面 NO
dynamicId 動態id NO
userId 評論使用者id NO
username 評論使用者姓名 NO
content 評論內容 NO
replayId 回覆評論的評論人id YES
replyNickname 回覆評論的評論人姓名 YES
  • 返回的結果形式
{
    "code": 1,
    "message": "013d893c-2cde-463a-a992-c6d0ca6849e9",
    "time": "2017-08-19T23:37:49.795",
    "result": null
}
複製程式碼

###點贊介面(Post請求)

  • 介面 dynamic/addlike
  • 引數
引數 引數解釋 是否為空
token 登入成功返回的token 這個要放到請求頭裡,伺服器端根據你的請求頭來判斷是否已經登入,可以做到單點登入 NO
userId 使用者id NO
dynamicId 點讚的動態id NO
  • 返回的資料形式
{
    "code": 1,
    "message": "ok",
    "time": "2017-08-19T23:37:49.795",
    "result": null
}
複製程式碼

所有動態介面

  • 介面dynamic/list
  • 引數
引數 引數解釋 是否為空
token 登入成功返回的token 這個要放到請求頭裡,伺服器端根據你的請求頭來判斷是否已經登入,可以做到單點登入 YES
index 當前頁數 NO
count 每頁的數量 NO
userId 當前使用者id NO
  • 返回的形式
{
    "code": 1,
    "message": "ok",
    "time": "2017-08-20T00:16:25.958",
    "result": [
        {
            "dynamicId": "123c1272-94e2-48bb-8c25-e541359ecd00",
            "dynamicContent": "完成了第一次釋出朋友圈的功能",
            "viewCount": "253",
            "likeCount": "2",
            "isLiked": false,
            "commentCount": "0",
            "createData": "2017-08-18T16:18:23",
            "createdDateLabel": null,
            "userId": "50cc22cf-9334-4e40-aa82-e9ca74de84ee",
            "username": "若蘭明月",
            "avatar": "http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg",
            "photos": "null",
            "comments": [],
            "mLikeds": [
                {
                    "userId": "50cc22cf-9334-4e40-aa82-e9ca74de84ee",
                    "avatar": "http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg"
                },
                {
                    "userId": "56e5ef1f-2f99-48e7-a846-70c5a0007073",
                    "avatar": "http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg"
                }
            ]
        },
        {
            "dynamicId": "e7894d9a-a742-46f5-9d99-2661214f074d",
            "dynamicContent": "完成了第一次釋出朋友圈的功能",
            "viewCount": "101",
            "likeCount": "2",
            "isLiked": true,
            "commentCount": "1",
            "createData": "2017-08-20T00:04:22",
            "createdDateLabel": null,
            "userId": "56e5ef1f-2f99-48e7-a846-70c5a0007073",
            "username": "若蘭明月3",
            "avatar": "http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg",
            "photos": "[\"http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg\",\"http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg\",\"http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg\",\"http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg\"]",
            "comments": [
                {
                    "commentId": "56e5ef1f-2f99-48e7-a846-70c5a0007073",
                    "userId": "56e5ef1f-2f99-48e7-a846-70c5a0007073",
                    "nickname": "若蘭明月3",
                    "replyUserid": null,
                    "replyNickname": null,
                    "content": "大俠為何如此威風，何不讓小弟快活快活呀"
                }
            ],
            "mLikeds": [
                {
                    "userId": "50cc22cf-9334-4e40-aa82-e9ca74de84ee",
                    "avatar": "http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg"
                },
                {
                    "userId": "56e5ef1f-2f99-48e7-a846-70c5a0007073",
                    "avatar": "http://loveruolan.oss-cn-shanghai.aliyuncs.com/portrait/201707/6e8ad1e62302f9c446b78c00d51b9cff.jpg"
                }
            ]
        }
    ]
}
複製程式碼

刪除評論介面(Post請求)

  • 介面dynamic/delete/comment
  • 引數
引數 引數解釋 是否為空
token 登入成功返回的token 這個要放到請求頭裡,伺服器端根據你的請求頭來判斷是否已經登入,可以做到單點登入 NO
commentId 當前的評論的ID NO
dynamicId 當前評論所在的動態ID NO
userId 當前使用者id NO
  • 返回的資料形式
{
    "code": 1,
    "message": "ok",
    "time": "2017-08-20T00:23:57.340",
    "result":null
}
複製程式碼

取消收藏介面(Post請求)

  • 介面dynamic/hidelike
  • 引數
引數 引數解釋 是否為空
token 登入成功返回的token 這個要放到請求頭裡,伺服器端根據你的請求頭來判斷是否已經登入,可以做到單點登入 NO
dynamicId 當前評論所在的動態ID NO
userId 當前使用者id NO
  • 返回的資料形式
{
    "code": 1,
    "message": "ok",
    "time": "2017-08-20T00:31:12.359",
    "result": null
}
複製程式碼

專案地址

  • https://github.com/wuyinlei/CNTest
  • https://github.com/wuyinlei/CNTest
  • https://github.com/wuyinlei/CNTest

相關文章