# PalmWebsite-Backend - cloverstd

**Repository Path**: isaced/PalmWebsite-Backend---cloverstd

## Basic Information

- **Project Name**: PalmWebsite-Backend - cloverstd
- **Description**: No description available
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2014-03-19
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


#目前实现的功能

* 网站收录/反链查询
    * Baidu
    * Google
    * so(360)
    * Bing
    * Sogou

* PageRank
* SEO综合
    * title
    * keywords
    * description
* 备案

## 接口说明

除了添加站点接口为`PUT`外，其余都是`GET`，返回`JSON`数据

成功请求的返回（HTTP STATUS CODE 为200）
```
{
    "success": true,
    "data": 8
}
```
失败请求的返回（HTTP STATUS CODE 为400/404）
```
{
    "success": false,
    "text": "缺少参数domain"
}
```

## 接口列表

Tips:除了站点添加接口，其余的所有的接口都遵循以下逻辑过程

1. 数据库无站点信息，直接通过spider查询
2. 数据库有站点数据
    1. 带有`refresh`参数，直接通过spider查询并且更新数据库
    2. 没有`refresh`参数，返回数据库里数据（TODO：判断数据是否存在）

###SEO综合查询

* 接口：/api/1/site_info
* 参数：
    * domain: string（域名） - 必选
    * refresh: bool（需要刷新） - 可选
* 说明：SEO综合查询，title、keywords、description

###收录查询

* 接口：/api/1/site_index/\<string:se\>
* 参数：
    * domain: string（域名） - 必选
    * refresh: bool（需要刷新） - 可选
    * se: string（搜索引擎） - 必选
        * so
        * baidu
        * google
        * bing
        * sogou
* 说明：收录情况

###反链查询

* 接口：/api/1/site_link/\<string:se\>
* 参数：
    * domain: string（域名） - 必选
    * refresh: bool（需要刷新） - 可选
    * se: string（搜索引擎） - 必选
        * so
        * baidu
        * google
        * bing
        * sogou
* 说明：反链情况

###备案查询

* 接口：/api/1/site_beian
* 参数：
    * domain: string（域名） - 必选
    * refresh: bool（需要刷新） - 可选
* 说明：备案信息查询

###Alexa查询

* 接口：/api/1/alexa
* 参数：
    * domain: string（域名） - 必选
    <!--* refresh: bool（需要刷新） - 可选-->
* 说明：Alexa查询

###添加站点

* 接口：/api/1/site
* 参数：
    * domain: string（域名） - 必选
* 说明：PUT方法，站点的添加，GET方法查询站点是否添加

##状态码说明

###缺少参数

* 状态码：10000
* 错误描述：缺少参数domain

###搜索引擎不支持

* 状态码：20000
* 错误描述：搜索引擎不支持

###资源错误

* 状态码：30000
* 错误描述：ID不存在

* 状态码：30001
* 错误描述：域名未添加

* 状态码：30002
* 错误描述：域名已添加