Owlistic项目API接口全面解析与使用指南

Owlistic是一款功能强大的笔记应用，提供了完善的API接口体系，支持用户认证、笔记管理、笔记本管理以及实时协作等功能。本文将深入解析Owlistic项目的API设计，帮助开发者更好地理解和使用这套接口。

一、认证系统API

Owlistic采用标准的JWT认证机制，提供了完整的用户认证流程。

1. 用户登录

• 端点：POST /api/v1/auth/login
• 请求体：需要提供邮箱和密码
• 响应：返回access_token和refresh_token
• 自动化处理：Postman测试脚本会自动将返回的token存入环境变量

{
    "email": "[e-mail]",
    "password": "securepassword"
}

2. 用户注册

• 端点：POST /api/v1/auth/register
• 请求体：需要提供邮箱、密码和用户名
• 特点：注册成功后自动登录，返回token

{
    "email": "[e-mail]",
    "password": "securepassword",
    "name": "New User"
}

3. Token刷新机制

• 端点：POST /api/v1/auth/refresh
• 请求体：提供refresh_token
• 作用：获取新的access_token，延长会话有效期

4. 用户登出

• 端点：POST /api/v1/auth/logout
• 认证：需要携带有效的access_token
• 效果：清除客户端存储的token

二、WebSocket实时通信API

Owlistic提供了基于WebSocket的实时通信能力，支持笔记实时更新和协作编辑。

1. WebSocket连接建立

• 端点：GET /ws 或 /api/v1/ws
• 认证：通过URL参数或Header传递access_token
• 用途：建立持久化的双向通信通道

2. 笔记实时更新

• 端点：WEBSOCKET /api/v1/ws/notes/{noteId}
• 消息格式：支持发送更新操作，如内容修改
• 示例消息：

{
  "type": "update",
  "data": {
    "blocks": [
      {
        "id": "block123",
        "content": "Real-time updated content"
      }
    ]
  }
}

3. 协作编辑功能

• 端点：WEBSOCKET /api/v1/ws/collaboration/{noteId}
• 功能：支持实时同步光标位置、编辑状态等
• 示例消息：

{
  "type": "cursor_position",
  "data": {
    "position": {
      "blockId": "block123",
      "offset": 10
    }
  }
}

三、笔记管理API

Owlistic提供了完整的CRUD操作接口来管理笔记。

1. 创建笔记

• 端点：POST /api/v1/notes
• 请求体：包含标题、所属笔记本ID、内容块等
• 内容块结构：支持多种类型的内容块，如文本、图片等

{
    "title": "Test Note",
    "user_id": "user123",
    "notebook_id": "notebook456",
    "blocks": [
        {
            "type": "text",
            "content": "This is a test note",
            "order": 1
        }
    ]
}

2. 获取笔记列表

• 端点：GET /api/v1/notes
• 返回：当前用户的所有笔记列表
• 分页：支持分页参数（虽然示例中未展示）

3. 获取单个笔记详情

• 端点：GET /api/v1/notes/{noteId}
• 返回：笔记的完整内容，包括所有内容块

4. 更新笔记

• 端点：PUT /api/v1/notes/{noteId}
• 请求体：可更新标题、内容、标签等
• 注意：支持部分更新，只需发送需要修改的字段

5. 删除笔记

• 端点：DELETE /api/v1/notes/{noteId}
• 效果：将笔记标记为已删除（软删除）

四、笔记本管理API

笔记本用于组织和管理相关笔记，提供分类功能。

1. 创建笔记本

• 端点：POST /api/v1/notebooks
• 请求体：需要提供名称、描述和所属用户ID

{
    "name": "Test Notebook",
    "description": "Test Description",
    "user_id": "user123"
}

2. 获取笔记本列表

• 端点：GET /api/v1/notebooks
• 返回：当前用户的所有笔记本
• 关联数据：可能包含笔记数量等统计信息

3. 获取笔记本详情

• 端点：GET /api/v1/notebooks/{notebookId}
• 返回：笔记本详细信息及包含的笔记列表

五、最佳实践与开发建议

1. Token管理：合理使用refresh_token机制，避免频繁要求用户重新登录
2. 错误处理：所有API都遵循统一的错误响应格式
3. 实时更新：对于协作场景，建议结合WebSocket和REST API使用
4. 性能优化：对于内容较多的笔记，考虑分块加载机制
5. 安全建议：确保所有请求都通过HTTPS传输，特别是认证相关接口

Owlistic的API设计遵循RESTful原则，同时通过WebSocket扩展了实时能力，为开发者提供了灵活而强大的集成方案。无论是构建客户端应用还是进行系统集成，这套API都能满足各种复杂场景的需求。