girineko/YesPlayMusic
1
0
Fork 0
mirror of https://github.com/GiriNeko/YesPlayMusic.git synced 2025-12-17 13:48:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: update api comments with jsdoc.

Browse source
This commit is contained in:
kunkka 2020-10-25 13:55:19 +08:00
parent 88f526597c
commit 223b7323a3
8 changed files with 186 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

41
src/api/auth.js
View file

@ -1,25 +1,33 @@
import request from "@/utils/request";
/**
* 手机登录
* - phone: 手机号码
* - password: 密码
* - countrycode: 国家码，用于国外手机号登录，例如美国传入：1
* @param {Object} params
* @param {string} params.phone
* @param {string} params.password
* @param {string=} params.countrycode
*/
export function loginWithPhone(params) {
//必选参数 :
// phone: 手机号码
// password: 密码
// 可选参数 :
// countrycode: 国家码，用于国外手机号登录，例如美国传入：1
// md5_password: md5加密后的密码,传入后 password 将失效
return request({
url: "/login/cellphone",
method: "post",
params,
});
}
/**
* 邮箱登录
* - email: 163 网易邮箱
* - password: 密码
* - md5_password: md5加密后的密码,传入后 password 将失效
* @param {Object} params
* @param {string} params.email
* @param {string} params.password
* @param {string=} params.md5_password
*/
export function loginWithEmail(params) {
// 必选参数 :
// email: 163 网易邮箱
// password: 密码
// 可选参数 :
// md5_password: md5加密后的密码,传入后 password 将失效
return request({
url: "/login",
method: "post",
@ -27,6 +35,11 @@ export function loginWithEmail(params) {
});
}
/**
* 刷新登录
* 说明 : 调用此接口 , 可刷新登录状态
* - 调用例子 : /login/refresh
*/
export function loginRefresh() {
return request({
url: "/login/refresh",
@ -34,6 +47,10 @@ export function loginRefresh() {
});
}
/**
* 退出登录
* 说明 : 调用此接口 , 可退出登录
*/
export function logout() {
return request({
url: "/logout",