# TGapi

**Repository Path**: vinsonJiang/TGapi

## Basic Information

- **Project Name**: TGapi
- **Description**: yanjin
- **Primary Language**: C#
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-08-02
- **Last Updated**: 2021-11-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#BaseUrl：http://tg.raincode.cn

##1.广告
### 1.1启动广告
- Url ： **/api/allStartUpAd**
- 参数：无
- 功能说明：获取当前启动广告的详细内容，应用程序第一次进入的时候，加载系统默认的一张图，然后调用该接口，获取启动广告的详细内容。如果返回的值为空`null`，则之后启动加载默认图片，否则之后加载缓存下来的图片。
- 返回值：见StartUpAdDto.cs文件属性  （单个实例）
- 返回参数：

```
{
         [string] name //广告名
         [string] path //图片路径
         [string] type //广告类型
         [string] resourceLink //链接url，可能为空
         [DateTime] startTime //开始时间
         [DateTime] endTime //结束时间
}

```

### 1.2 封面
- url: /api/coverList
- 参数：无
- 功能说明：获取多张封面
- 返回值：（实例数组）
- 返回参数：

```
[{
        [string] path //图片路径
        [string] resourceLink //链接url，可能为空
        [DateTime] startTime //开始时间
        [DateTime] endTime //结束时间
        [int] sort //排序
}]
```

### 1.3 导航栏广告
- Url：/api/navAd
- 参数：**navTypeId** : 某导航栏ID
- 功能说明：获取该导航栏下面的所有轮播广告的信息
- 返回值：navAd.cs文件属性  （实例数组）
- 返回值说明：`sort:排序字段；      path:图片路径；    title:导航广告的标题；`
- 返回参数：

```
[{
        [string] path //图片路径
        [string] title //导航广告的标题
        [int] sort //排序
}]
```

### 1.4 导航栏
- Url：/api/allNavAdTypes
- 参数：无
- 功能说明：手机每次启动获取一次导航栏的所有图标内容，同时按照Sort图标进行排序（后端已排序好，开发的时候最好查看下返回数据是否按照此字段排序，因为数据有可能会混乱）
- 返回值：allNavAdTypes.cs文件属性  （实例数组）
- 返回参数：

```
[{
        [string] path //图片路径
        [string] title //导航广告的标题
        [int] sort //排序
}]
```

##2.新闻内容
###2.1 新闻列表
- Url：/api/newsList
- 参数：**navTypeId** : 某导航栏ID 
- 参数：**type** : 默认值为1 ，当为1的时候，动作为上拉刷新， 当为2的时候，动作为下拉刷新
- 参数：**impId** : 当下拉刷新的时候，为该列数组最上面新闻ID，当为上拉刷新的时候为该列数组最下面的新闻ID
- 参数：**size** : 每次请求的数据量大小，默认值为6
- 参数：**classifyId** ：要获取的新闻栏目Id（0表示全部）
- 功能说明：获取某导航栏下面的新闻列表信息
- 返回值：newsList.cs文件属性  （实例数组）`path：为图片的路径；finalScale：为权值排序字段`
- 返回参数：

```
[{
         [int] Id //新闻id
         [string] path //图片路径
         [string] title //标题
         [int] finalScale //权值
         [DateTime] created_at //创建时间
         [int] hasValue //是否有视频
}]
```

###2.2 获取新闻详细内容
- Url：/api/news
- 参数：**newsId** : 某具体新闻的ID
- 参数：**personId** : 手机本地用户ID
- 功能说明：获取某具体新闻的详细信息
- 返回值：news.cs文件属性  （单个实例）

```
{
         [int] Id //新闻id
         [string] author//作者
         [string] title //标题
         [string] content//内容
         [int] like //点赞量
         [int] clicked //点击量
         [DateTime] created_at //创建时间
         [DateTime] updated_at //最近一次修改时间
}

```

##3.新闻留言信息
###3.1 添加留言
- Url：/api/addMessage
- 参数：**content** : 某新闻的详细内容  
- 参数：**personId** : 手机本地用户ID
- 参数：**newsId** : 新闻ID
- 功能说明：获取某具体新闻的详细信息
- 返回值：无，具体添加成功与否，查看httpstatus状态码


###3.2 获取留言列表
- Url：/api/messageList
- 参数：**newsId** : 某新闻的ID
- 参数：**page** : 列表的分页表示，默认值为0
- 参数：**size** : 每次获取的数量，默认值为6
- 功能说明：page模拟网页分页概念，每次获取数据后，page++
- 返回值：messageList.cs文件属性   （实例数组）

```
[{
        [int] Id //评论id
        [string] personName //用户名
        [string] content //内容
        [DateTime] publishTime //评论时间
        [int] like //点赞数
}]
```

##3初始化用户信息
- Url：/api/initPersonInfo
- 参数：**phone** : 用户的手机号码
- 功能说明：每个手机用户必须有本地用户，用户第一次进入APP，都需要执行这一步来进行用户信息的初始化
- 返回值：initPersonInfo.cs文件属性   （实例数组）


##4用户反馈（暂时没用）
- Url：/api/feedBack
- 参数：**content** : 反馈的内容
- 参数：**personId** : 用户ID
- 功能说明：用户反馈的功能
- 返回值：具体调用成功与否，需要查看httpstatus状态码

##5点赞
###5.1获取文章点赞数量
- Url：/api/getNewsLikeNum
- 参数：**newsId** : 新闻ID
- 功能说明：获取某篇新闻的点赞数量
- 返回值：
```javascript
{
status:0,msg:num
}
```

###5.2获取评论点赞数量
- Url：/api/getCommentLikeNum
- 参数：**commentId** : 评论ID
- 功能说明：获取某条评论的点赞数量
- 返回值：
```javascript
{
status:0,msg:num
}
```

###5.3 添加新闻点赞
- Url：/api/addNewsLike
- 参数：**newsId** : 新闻ID
```javascript
{status：1表示成功，0表示失败}   
```

###5.4 添加评论点赞
- Url：/api/addCommentLike
- 参数：**newsId** : 评论ID
```javascript
{status：1表示成功，0表示失败}   
```

###6.1 检查更新
- Url：/api/checkApp
- 参数：无
- 功能说明：检查app最新版本（单个实例）
- 返回值：

```
{
        [int] isForce    //0：不强制更新，1：强制更新
        [string] androidVersion    //Android最新版版本号
        [string] androidUrl    //Android最新版app下载地址
        [string] iosVersion    //iOS最新版版本号
        [string] iosUrl    //iOS最新版app下载地址
        [string] description    //更新日志描述
}

```

###7.1 获取栏目列表
- Url：/api/classifyList
- 参数：navId    导航id
- 功能说明：获取栏目列表（实例数组）
- 返回值：

```
[{
        [int] id    //栏目Id
        [string] name    //栏目名
        [int] sort    //排序
        [string] path    //图标路径
}]
```

##8 晒晒版块
###8.1 上传图片新闻
- Url：/api/uploadNews
- 参数：content    内容
- 功能说明：上传图片和文字新闻
- 返回值：
```javascript
{status：1表示成功，0表示失败， msg：返回信息}   
```

###8.2获取用户上传列表
- url: /api/userNewsList
- 参数：deviceId    设备id
- 参数：**page** : 列表的分页表示，默认值为1(即为前6条)
- 参数：**size** : 每次获取的数量，默认值为6
- 功能说明：获取用户上传的晒晒新闻
- 返回值：（实例数组）

```
[{
        [int] id //新闻id
        [string] title //标题
        [DateTime] created_at //创建时间
        [int] status //状态（1：已审核，0：未审核）
}]

```

###8.3删除已上传的晒晒新闻
- url: /api/delUserNews
- 参数：deviceId    设备id
- 参数：newsId    新闻id
- 功能说明：获取用户上传的晒晒新闻
- 返回值：（实例数组）
```javascript
{status：1表示成功，0表示失败， msg：返回信息}   
```