docs: 完善注释

Former-commit-id: 7a03ecf0ed497da80924b8f6a5117c2e783b6d4d

src/api/auth/index.ts

@@ -3,6 +3,7 @@ import { AxiosPromise } from 'axios';
 import { LoginData, LoginResult } from './types';
 
 /**
+ * 登录API
  *
  * @param data {LoginData}
  * @returns
@@ -16,7 +17,7 @@ export function loginApi(data: LoginData): AxiosPromise<LoginResult> {
 }
 
 /**
- * 注销
+ * 注销API
  */
 export function logoutApi() {
   return request({

src/api/auth/types.ts

@@ -1,8 +1,14 @@
 /**
- * 登录请求
+ * 登录请求参数
  */
 export interface LoginData {
+  /**
+   * 用户名
+   */
   username: string;
+  /**
+   * 密码
+   */
   password: string;
 }
 
@@ -10,16 +16,20 @@ export interface LoginData {
  * 登录响应
  */
 export interface LoginResult {
-  accessToken: string;
-  tokenType: string;
-  refreshToken: string;
-  expires: number;
-}
-
-/**
- * 验证码类型
- */
-export interface VerifyCode {
-  verifyCodeImg: string;
-  verifyCodeKey: string;
+  /**
+   * 访问token
+   */
+  accessToken?: string;
+  /**
+   * 过期时间(单位：毫秒)
+   */
+  expires?: number;
+  /**
+   * 刷新token
+   */
+  refreshToken?: string;
+  /**
+   * token 类型
+   */
+  tokenType?: string;
 }