自研PHP框架登录功能的标准AJAX响应规范咨询

Hey there! Nice work building out your custom PHP framework and getting the auth system (database integration, registration, login/logout) up and running smoothly—those are critical pieces, so kudos on that.

Right now, returning raw numeric codes works, but as your app scales, you’ll find it quickly becomes hard to maintain and debug. The standard, industry-adopted format for AJAX auth responses is JSON—it’s human-readable, easy to parse on the frontend, and flexible enough to carry all the info you need.

Here’s a breakdown of what a robust response structure should include, along with examples:

Core Components of the Response #

• success: A boolean (true/false) that immediately tells the frontend if the login attempt succeeded. No more guessing what "0" or "1" means at a glance.
• code: A semantic identifier (string or numeric) for the specific result. This is helpful for frontend logic (e.g., showing different error messages) and debugging. Strings like INVALID_USERNAME are more intuitive than raw numbers, but you can keep numeric codes if you prefer—just pair them with clear labels.
• message: A user-friendly string that can be directly displayed to the end user (e.g., "Password incorrect, please try again").
• data: An object (or null for failures) that carries additional useful data on success—like user details, an auth token, or session info. This avoids needing extra API calls to fetch user data after login.

Example Responses #

1. Login Success #

{
  "success": true,
  "code": "LOGIN_SUCCESS",
  "message": "登录成功",
  "data": {
    "userId": 456,
    "username": "your_user",
    "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." // If using JWT/session tokens
  }
}

2. Username Not Found #

{
  "success": false,
  "code": "INVALID_USERNAME",
  "message": "用户名不存在，请检查输入",
  "data": null
}

3. Incorrect Password #

{
  "success": false,
  "code": "INVALID_PASSWORD",
  "message": "密码错误，请重试",
  "data": null
}

4. Partial/Incomplete Form (Your "2" case) #

{
  "success": false,
  "code": "INCOMPLETE_FORM",
  "message": "请完整填写登录信息",
  "data": null
}

PHP Implementation Tips #

When sending the response from your PHP backend, make sure to:

1. Set the correct HTTP header to tell the frontend it’s receiving JSON:

   header('Content-Type: application/json');
   

2. Use json_encode() to convert your PHP array to a JSON string:

   // Example for a failed login (username error)
   $response = [
       'success' => false,
       'code' => 'INVALID_USERNAME',
       'message' => '用户名不存在，请检查输入',
       'data' => null
   ];
   
   echo json_encode($response);
   exit; // Stop execution after sending the response
   

3. Pair with appropriate HTTP status codes (optional but recommended):
   • Use 200 OK for successful logins.
   • Use 401 Unauthorized for invalid credentials (username/password errors).
   • Use 400 Bad Request for incomplete form data.
   • Use 500 Internal Server Error for server-side issues (e.g., database connection failures).

This structure makes your API self-documenting, easier for frontend devs (or future you) to work with, and scales seamlessly as you add more auth features (like multi-factor auth, password reset, etc.).

内容的提问来源于stack exchange，提问作者Sertilou