# django_api_server

**Repository Path**: qinyakun/django_api_server

## Basic Information

- **Project Name**: django_api_server
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-27
- **Last Updated**: 2022-01-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# api

#### 项目介绍
{**以下是码云平台说明，您可以替换为您的项目简介**
码云是开源中国推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台
无论是个人、团队、或是企业，都能够用码云实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}

#### 软件架构
软件架构说明


#### 安装教程

1. xxxx
2. xxxx
3. xxxx

#### 使用说明
**接口描述：**

添加客户积分数据。 

<br>

**请求示例：**

> 请求方式: POST <br>
请求URL： /add_ranking  
数据格式：JSON  


**POST示例：**
```
{
    "client": "客户端1",
    "num": "88888"
}
```

**POST请求参数说明：** 


|     参数     | 必选 | 说明         |
|  ---------- | --- | ----------   |
| client   |  是 | 客户端|  
| num    |  是 |  分数 |      

<br>

 **返回示例：** 

```
{
    "errcode": 200,
    "errmsg": "成功"
}
```
<br>

**返回参数说明：** 


|     参数      | 说明                     |
|  ----------  | --------------------     |
| errcode      | 0为成功，其他为错误码       |
| errmsg       | 错误提示，成功时显示"ok"    |


获取客户积分排行数据列表。 

<br>

**请求示例：**

> 请求方式: GET <br>
请求URL： /add_ranking  


**请求参数说明：** 


|     参数     | 必选 | 说明         |
|  ---------- | --- | ----------   |
| client   |  是 | 客户端|  
| page    |  否 |  页 |
| size    |  否 |  每页数量 |
| top    |  否 |  排名范围 （最小排名）|
| bottom    |  否 |  排名范围（最大排名）|



<br>

 **返回示例：** 

```
{
    "errcode": "200",
    "errmsg": "成功",
    "data": {
        "total": 6,
        "list": [
            {
                "id": 4,
                "ranking": 1,
                "client": "客户端8",
                "num": 222222
            }
        ]
    }
}
```
<br>

**返回参数说明：** 


|     参数      | 说明                     |
|  ----------  | --------------------     |
| errcode      | 0为成功，其他为错误码       |
| errmsg       | 错误提示，成功时显示"ok"    |
| data         | 数据体，只有请求成功时才显示 |
| total        | 符合条件的数据总数          |
| list         | 数据列表，当total=0时不显示 |
| id          | id|
| ranking       | 客户端排名|
| client        | 客户端名称|
| num         | 分数|