Service for Education Social Network

NOTE

Các gói tin trả về có dạng: {code:<logic_code>, message: <detail_infomation>, data: <object_data>, [error: <error_object>]}.

Logic code ở trên độc lập với HTTP_RESPONSE_CODE mặc định của giao thức HTTP, do vậy các lỗi liên quan đến kết nối (VD: timeout...) sẽ không được mô tả. Thông thường <logic_code> sẽ trùng với HTTP_RESPONSE_CODE. App sử dụng service nên tự động bắt các lỗi này, đặc biệt là timeout.

Một số <logic_code> mặc định (dựa trên chuẩn HTTP) :
    + 1xx: Information.
    + 2xx: Success.
    + 3xx: Redirection.
    + 4xx: Client Error.
    + 5xx: Server Error.

Các API sử dụng `userID`, sau sẽ được hỗ trợ thêm thông qua lưu trữ session phía service.

Việc phân quyền về sau cũng sẽ sử dụng `userID` đã đăng nhập để kiểm tra (VD: Thao tác đối với người file, user, class, post...). Các API không đủ quyền xem xét service sẽ tự chuyển hướng đến giao diện tương ứng (đăng nhập/chấp nhận quyền);

Các trường thông tin theo key:value đều hỗ trợ 2 định dạng _FORM_ & _JSON_ ngoại trừ các trường thông tin đặc biệt như file(dùng form-multilpart, có thể xem xét truyền dữ liệu dưới định dạng BinaryToText như `Base64` cho các file nhỏ trực tiếp trên định dạng JSON).

REFERENCE

API_DETAIL_UPDATE_LINK

CHANGE LOG

UPDATE LOG

`23/10/2017`

Xong các API FileManager: `/files/*`

Thông tin FileItem bao gồm:

    id: :fileID
    name: ten_file_gui_len
    type: mime_type
    size: kich_thuoc_file_tinh_theo_byte
    createDate: thoi_gian_upload_theo_timezone_service

Upload 1 file (`/temp/test.html`)

+ Method: POST
+ URL: "http://domain:port/files/upload"
+ InputName: fileUpload"
+ Chưa có các chức năng lọc: size, type.
+ Chưa lưu người dùng upload: sẽ bổ sung sau.
+ Success: `data` chứa thông tin file vừa tài.
    {code: 200, message: '...', data: <file_info>}
+ Failed:
    {code: 500, message:..., data: null, error:error_message}

Upload 1 ảnh: Tương tự như upload file (`/temp/test.html`)

+ Method: POST
+ URL: http://domain:port/files/image"
+ InputName: imageUpload
+ Lọc chỉ file có đuôi "jpg/jpeg/png/gif", chưa lọc size.
+ Success: `data` là thông tin file đã upload.
    - {code: 200, message: "...", data: <file_info>}
+ Failed:
    - {code: 500, ...} : Client Error: Không upload được.
    - {code: 400, ...} : Server Error: File upload không thỏa mãn.

Xóa 1 file bằng `fileID` `(/temp/test.html)`

+ Method: DELETE
+ URL: http://domain:port/files/delete/:fileID : fileID cần xóa.
+ Success: `data` là thông tin file đã xóa.
    - {code: 200, message: "...", data: <file_info>}
+ Failed:
    - {code: 400, ...} : Client Error: Không tồn tại file.
    - {code: 500, ...} : Server Error: Không thể xóa.

Lấy thông tin file bằng `fileID`

+ Method: GET
+ URL: http://domain:port/files/info/:fileID : fileID cần lấy thông tin.
+ Success: `data` là thông tin file cần lấy.
    - {code: 200, message: "...", data: <fileID>}
+ Failed:
    - {code: 400, ...} : Client Error: Không tồn tại file.
    - {code: 500, ...} : Server Error: Không thể lấy thông tin.

Tải file, ảnh bằng `fileID`

+ Method: GET
+ URL: http://domain:port/files/get/:fileID (nên dùng khi load ảnh trên trình duyệt) hoặc http://domain:port/files/attach/:fileID (nên dùng khi tải file/ảnh): fileID cần tải.
+ Success: trả về file download (ghi trực tiếp xuống http_body, thông tin file trong http_header).
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Không tồn tại file.
    - {code: 500, ...} : Server Error: Không thể lấy thông tin.

`[TEST_API]` Lấy về tất cả file tải lên: `(sau sẽ thay bằng người dùng)`

+ Method: GET
+ URL: http://domain:port/test/files
+ Success: `data` là mảng thông tin file.
    - {code: 200, message: "...", data: [...files]}
+ Failed:
    - {code: 500, ...} : Server Error: Không thể lấy thông tin.

`31/10/2017`

Xong các API cơ bản của User: `/users/*`

Thông tin User bao gồm:

    id: userID unique
    username: user_name
    typeuser: type_user
    password: pass_word
    firstName: firstName
    lastName: lastname
    email: email|null:unique
    phone: phone|null:unique
    profileImageID: profile_image_fileID
    coverImageID: cover_image_fileID
    birthday: birthday
    gender: [NONE, FEMALE, MALE]
    about: about
    quote : quote
    nickname: array_string_nickname
    skills: array_skill
    worked: array_work
    language: array_language
    lifeEvent: array_life_Event
    classs: array_id_classs
    friends: array_id_friends
    status: [NEW, BLOCKED, NORMAL]
    location: location

NOTE : Thông tin cơ bản trả cho thông tin người dùng mặcđịnh không bao gồm: password, skills, friends, classs, status, lifeEvent (Sẽ có API riêng).

Tạo người dùng với `username`

+ Method: POST
+ URL: http://domain:port/users/
+ Success: `data` là thông tin User được tạo.
    - {code: 200, message: "...", data: <user_info>}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Update thông tin người dùng qua `username`, không thể thay đổi `userID`, `username`

+ Method: PUT
+ URL: http://domain:port/users/
+ Success: `data` là thông tin User được update.
    - {code: 200, message: "...", data: <user_info>}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Thay đổi thông tin người dùng qua `userID`

+ Method: PUT
+ URL: http://domain:port/users/:userID
+ Success: `data` là thông tin User được update.
    - {code: 200, message: "...", data: <user_info>}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Lấy thông tin cơ bản người dùng qua `userID`

+ Method: GET
+ URL: http://domain:port/users/:userID
+ Success: `data` là thông tin User cần lấy.
    - {code: 200, message: "...", data: <user_info>}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Xóa người dùng qua `userID`

+ Method: DELETE
+ URL: http://domain:port/users/:userID
+ Success: `data` là thông tin User xóa.
    - {code: 200, message: "...", data: <user_info>}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Danh sách bạn qua `userID`

+ Method: GET
+ URL: http://domain:port/users/friends/:userID
+ Success: `data` mảng id người dùng là bạn.
    - {code: 200, message: "...", data: [...friendIDs]}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Danh sách nhóm qua `userID`

+ Method: GET
+ URL: http://domain:port/users/classs/:userID
+ Success: `data` mảng id nhóm.
    - {code: 200, message: "...", data: [...classs]}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Danh sách file người dùng qua `userID`

+ Method: GET
+ URL: http://domain:port/users/files/:userID
+ Success: `data` mảng id file.
    - {code: 200, message: "...", data: [...files]}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Lấy ảnh Profile qua `userID`

+ Method: GET
+ URL: http://domain:port/users/profileImage/:userID
+ Success: Trả về file download (ghi trực tiếp xuống http_body, thông tin file trong http_header).
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Thay đổi ảnh Profile qua `userID`

+ Method: PUT, POST
+ URL: http://domain:port/users/profileImage/userID
+ InputName: `profileImage`.
+ Success: Thông tin tin file profile đã upload.
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Lấy ảnh Cover qua `userID`

+ Method: GET
+ URL: http://domain:port/users/coverImage/:userID
+ Success: Trả về file download (ghi trực tiếp xuống http_body, thông tin file trong http_header).
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Thay đổi ảnh cover qua `userID`

+ Method: PUT, POST
+ URL: http://domain:port/users/coverImage/:userID
+ InputName: `coverImage`.
+ Success: Thông tin file avatar đã upload.
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

`[TEST_API]` Lấy về tất cả User

+ Method: GET
+ URL: http://domain:port/test/users
+ Success: `data` là mảng thông tin user.
    - {code: 200, message: "...", data: [...users]}
+ Failed:
    - {code: 500, ...} : Server Error: Không thể lấy thông tin.

`03/11/2017`

Xong các API Check cơ bản của kiểm tra tồn tại username/email/phone: `/checks/*`

Kiểm tra `username` đã sử dụng qua `:username`

+ Method: GET
+ URL: http://domain:port/checks/username/:username
+ Success: HTTP_RESPONSE_CODE = 200
+ Failed: HTTP_RESPONSE_CODE != 200

Kiểm tra `email` đã sử dụng qua '`?email=...`'

+ Method: GET
+ URL: http://domain:port/checks/email?email=abc@gmail.com
+ Success: HTTP_RESPONSE_CODE = 200
+ Failed: HTTP_RESPONSE_CODE != 200

Kiểm tra `phone` đã sử dụng qua `?phone=...`

+ Method: GET
+ URL: http://domain:port/checks/phone/:phone=0123456xxx
+ Success: HTTP_RESPONSE_CODE = 200
+ Failed: HTTP_RESPONSE_CODE != 200

`07/11/2017`

Xong các API cơ bản của Group: `/groups/*`

Thông tin User bao gồm:

    id: id_group unique
    name: group_name
    typegroup: type_group
    profileImageID: profile_image_fileID
    coverImageID: cover_image_fileID
    dateCreated: dateCreate
    typeGroup: [PRIMARY, SECONDARY, UNIVERSITY]
    about: about
    tags: tags
    language: array_language
    members: [{id:user, typemember:type_member}]
    status: [NEW, BLOCKED, NORMAL]
    location: location

NOTE :

Tạo nhóm

+ Method: POST
+ URL: http://domain:port/groups/
+ Success: `data` là thông tin Group User được tạo.
    - {code: 200, message: "...", data: <group_info>}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Update thông tin nhóm qua `groupID`

+ Method: PUT
+ URL: http://domain:port/groups/:groupID
+ Success: `data` là thông tin Group được update.
    - {code: 200, message: "...", data: <group_info>}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Lấy thông tin cơ bản nhóm qua `groupID`

+ Method: GET
+ URL: http://domain:port/groups/:groupID
+ Success: `data` là thông tin nhóm cần lấy.
    - {code: 200, message: "...", data: <group_info>}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Xóa nhóm qua `groupID`

+ Method: DELETE
+ URL: http://domain:port/groups/:groupID
+ Success: `data` là thông tin nhóm xóa.
    - {code: 200, message: "...", data: <nhóm_info>}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Danh sách thành viên qua `groupID`

+ Method: GET
+ URL: http://domain:port/groups/members/:groupID
+ Success: `data` mảng id người dùng là thành viên.
    - {code: 200, message: "...", data: [{id:id_member, typemember:type_member},...]}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Danh sách file nhóm qua `groupID`

+ Method: GET
+ URL: http://domain:port/groups/files/:grouprID
+ Success: `data` mảng id file.
    - {code: 200, message: "...", data: [...files]}
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Lấy ảnh Profile nhóm qua `groupID`

+ Method: GET
+ URL: http://domain:port/groups/profileImage/:groupID
+ Success: Trả về file download (ghi trực tiếp xuống http_body, thông tin file trong http_header).
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Thay đổi ảnh Profile nhóm qua `groupID`

+ Method: PUT, POST
+ URL: http://domain:port/groups/profileImage/:groupID
+ InputName: `profileImage`.
+ Success: Thông tin tin file profile đã upload.
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Lấy ảnh Cover nhóm qua `groupID`

+ Method: GET
+ URL: http://domain:port/groups/coverImage/:groupID
+ Success: Trả về file download (ghi trực tiếp xuống http_body, thông tin file trong http_header).
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

Thay đổi ảnh Cover nhóm qua `groupID`

+ Method: PUT, POST
+ URL: http://domain:port/groups/coverImage/:groupID
+ InputName: `coverImage`.
+ Success: Thông tin file cover đã upload.
+ Failed: HTTP_RESPONSE_CODE khác 200 trùng với <logic_code>
    - {code: 400, message:....} : Client Error: Thông tin lỗi (thiếu, sai định dạng).
    - {code: 500, ...} : Server Error: Không thể thực hiện.

`[TEST_API]` Lấy về tất cả nhóm

+ Method: GET
+ URL: http://domain:port/test/groupss
+ Success: `data` là mảng thông tin nhóm.
    - {code: 200, message: "...", data: [...users]}
+ Failed:
    - {code: 500, ...} : Server Error: Không thể lấy thông tin.

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
application		application
controllers		controllers
models		models
views		views
.env		.env
.gitignore		.gitignore
README.md		README.md
index.html		index.html
package-lock.json		package-lock.json
package.json		package.json
server.js		server.js
test.js		test.js

nkn6294live/educationsocialservice

Folders and files

Latest commit

History

Repository files navigation

Service for Education Social Network

NOTE

REFERENCE

CHANGE LOG

UPDATE LOG

23/10/2017

Xong các API FileManager: /files/*

Upload 1 file (/temp/test.html)

Upload 1 ảnh: Tương tự như upload file (/temp/test.html)

Xóa 1 file bằng fileID (/temp/test.html)

Lấy thông tin file bằng fileID

Tải file, ảnh bằng fileID

[TEST_API] Lấy về tất cả file tải lên: (sau sẽ thay bằng người dùng)

31/10/2017

Xong các API cơ bản của User: /users/*

Tạo người dùng với username

Update thông tin người dùng qua username, không thể thay đổi userID, username

Thay đổi thông tin người dùng qua userID

Lấy thông tin cơ bản người dùng qua userID

Xóa người dùng qua userID

Danh sách bạn qua userID

Danh sách nhóm qua userID

Danh sách file người dùng qua userID

Lấy ảnh Profile qua userID

Thay đổi ảnh Profile qua userID

Lấy ảnh Cover qua userID

Thay đổi ảnh cover qua userID

[TEST_API] Lấy về tất cả User

03/11/2017

Xong các API Check cơ bản của kiểm tra tồn tại username/email/phone: /checks/*

Kiểm tra username đã sử dụng qua :username

Kiểm tra email đã sử dụng qua '?email=...'

Kiểm tra phone đã sử dụng qua ?phone=...

07/11/2017

Xong các API cơ bản của Group: /groups/*

Tạo nhóm

Update thông tin nhóm qua groupID

Lấy thông tin cơ bản nhóm qua groupID

Xóa nhóm qua groupID

Danh sách thành viên qua groupID

Danh sách file nhóm qua groupID

Lấy ảnh Profile nhóm qua groupID

Thay đổi ảnh Profile nhóm qua groupID

Lấy ảnh Cover nhóm qua groupID

Thay đổi ảnh Cover nhóm qua groupID

[TEST_API] Lấy về tất cả nhóm

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages