No Fuss Bookmarks 技术文档

1. 安装指南

环境准备

在开始安装前，请确保您的系统中已安装以下环境：

• Python 3.x
• Flask
• mongoDB
• heroku-cli（可选，如果需要部署到heroku）

安装步骤

1. 克隆项目到本地：

   git clone https://github.com/your_username/no-fuss-bookmarks.git
   cd no-fuss-bookmarks
   

2. 安装项目依赖：

   pip install -r requirements.txt
   

3. 配置数据库连接：

   在项目根目录下创建一个 config.py 文件，并填入以下内容：

   MONGO_URI = "mongodb://localhost:27017/no_fuss_bookmarks"
   

   如果您使用的是远程数据库，请替换 MONGO_URI 为对应的数据库连接地址。

4. 启动服务：

   python app.py
   

   服务默认运行在 http://127.0.0.1:5000/。

2. 项目使用说明

Chrome 插件使用

1. 下载并安装 Chrome 插件。
2. 打开 Chrome 浏览器，点击插件图标，输入您的 API Key。
3. 在需要收藏的网页上点击插件图标，即可添加到您的书签库。

API 使用

项目提供了一个简单的 RESTful API，用于管理书签。

• POST /bookmarks：添加一个新的书签。
• GET /bookmarks：获取所有书签。
• GET /bookmarks/<id>：获取单个书签。
• PUT /bookmarks/<id>：更新单个书签。
• DELETE /bookmarks/<id>：删除单个书签。

示例

添加书签

请求：

POST /bookmarks
Content-Type: application/json

{
    "title": "示例网站",
    "url": "http://example.com",
    "description": "这是一个示例网站"
}

响应：

{
    "status": "success",
    "data": {
        "id": "5f2c8a8a8a8a8a8a8a8a8a8",
        "title": "示例网站",
        "url": "http://example.com",
        "description": "这是一个示例网站"
    }
}

获取书签

请求：

GET /bookmarks

响应：

{
    "status": "success",
    "data": [
        {
            "id": "5f2c8a8a8a8a8a8a8a8a8a8",
            "title": "示例网站",
            "url": "http://example.com",
            "description": "这是一个示例网站"
        }
    ]
}

3. 项目API使用文档

请参考上述“项目使用说明”中的“API 使用”部分。

4. 项目安装方式

请参考“安装指南”部分。