1 Star 0 Fork 0

Junmet / BigEventProject

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
EPL-1.0

运行说明 - 数据库

  1. 项目的数据保存在mysql中,先保证打开mysql

    1568597237554

  2. 在数据库中新建一个库bignews

    1568597384285

  3. 打开config/index.js中的 下面几个地方,调整成和自己数据库设置相同的设置

    *** 该配值为默认配值,如果不想要自定义数据库名称可以省略***

    // 库名
    database:'bignews',
    // 用户名
    username:'root',
    // 密码
    password:'root',
    // 主机
    host:'127.0.0.1',
    // 项目运行端口
    port:8080,
    // 项目基地址
    baseUrl:'http://localhost'

运行说明 - 初始数据

  1. 模拟的数据在reset文件夹中(进入到reset文件夹,点击右键选择Git Bash Hear打开小黑窗)
  2. 用node运行 index.js即可导入测试数据node index.js
  3. 等待操作结束

1568597640907

运行说明 - 运行项目

  1. 保证上述2步运行完毕之后,双击开启.bat即可
  2. 也可以输入命令node app.js

1568597752936

  • 以上只需要第一次配值即可,以后每天我们只需要做两件事
    • 1.开启phpstudy运行mysql数据库
    • 2.双击开始.bat打开服务器

1568598049185

项目基地址

项目的基地址是就是配置的地址比如配置的是

port:8080
baseUrl:'http://localhost'

那么项目的基地址就是:http://localhost:8080/api/v1

基地址+端口+/api/vi

接口说明

  • 接口认证统一使用 Token 认证
  • 需要授权的 API ,必须在请求头中使用 Authorization 字段提供 token 令牌
  • 使用 HTTP Status Code 标识状态
  • 数据返回格式统一使用 JSON

状态说明

状态码 含义 说明
200 OK 请求成功
201 CREATED 创建成功
204 DELETED 删除成功
400 BAD REQUEST 请求的地址不存在或者包含不支持的参数
401 UNAUTHORIZED 未授权
403 FORBIDDEN 被禁止访问
404 NOT FOUND 请求的资源不存在
422 Unprocesable entity [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误
500 INTERNAL SERVER ERROR 内部错误

后台接口

1、用户登录

请求地址:/admin/user/login

请求方式:post

请求参数:

名称 类型 说明
username string 用户名(admin)
password string 密码(123456)

返回数据:

名称 类型 说明
msg string 文字信息 ‘登录成功’ ‘用户名或密码出错’
token string 登录成功获取的token,后续的所有接口都依赖于token

2、获取用户信息

请求地址:/admin/user/info

请求方式:get

请求参数:无

返回数据:

名称 类型 说明
nickname string 用户昵称
userPic string 用户图片地址

3、获取用户详情

请求地址:/admin/user/detail

请求方式:get

请求参数:无

返回数据:

名称 类型 说明
username string 用户名称
nickname string 用户昵称
email string 用户邮箱
userPic string 用户图片地址
password string 用户密码

4、编辑用户信息

请求地址:/admin/user/edit

请求方式:post

请求数据:使用formData提交

名称 类型 说明
username string 用户名称
nickname string 用户昵称
email string 用户邮箱
userPic file 用户图片地址
password string 用户密码

返回数据:

名称 类型 说明
msg string 文字信息 ‘修改成功’ ‘修改失败’

5、所有文章类别

请求地址:/admin/category/list

请求方式:get

请求参数:无

返回数据:文章

名称 类型 说明
id number 类别
name string 类别名称
slug string 别名

6、新增文章类别

请求地址:/admin/category/add

请求方式:post

请求参数:

名称 类型 说明
name string 类别名称
slug string 别名

返回数据:

名称 类型 说明
msg string 文字信息 ‘增加成功’ ‘增加失败’

7、根据id查询指定文章类别

请求地址:/admin/category/search

请求方式:get

请求参数:id

名称 类型 说明
id number 文章类别id

返回数据:

名称 类型 说明
id number 类别
name string 类别名称
slug string 别名

8、编辑文章类别

请求地址:/admin/category/edit

请求方式:post

请求参数:

名称 类型 说明
id number 类别id
name string 类别名称
slug string 别名

返回数据:

名称 类型 说明
msg string 文字信息 ‘编辑成功’ ‘编辑失败’

9、删除文章类别

请求地址:/admin/category/delete

请求方式:post

请求参数:

名称 类型 说明
id number 文章id

返回数据:

名称 类型 说明
msg string 文字信息 ‘删除成功’ ‘删除失败’

10、文章搜索

请求地址:/admin/article/query

请求方式:get

请求参数:

名称 类型 说明
key string 搜索关键词,可以为空,为空返回某类型所有文章
type string 文章类型id,可以为空,为空返回所有类型文章
state string 文章状态,草稿 ,已发布,为空返回所有状态文章
page number 当前页,为空返回第1页
perpage number 每页显示条数,为空默认每页6条

返回数据:

名称 类型 说明
pages number 总页数
page number 当前页
data array 文章数据数组,其中每个成员包含字段:
id: number类型,文章id
title: string类型,文章标题
intro: string类型,文章文字内容截取
cover: string类型,文章封面图片地址
type: string类型,文章类型
read: number类型,文章阅读次数
comment: number类型,文章评论次数
date:string类型, 文章发布时间
state:string类型,文章状态

11、发布文章

请求地址:/admin/article/publish

请求方式:post

请求参数:通过formData提交

名称 类型 说明
title string 文章标题
cover file 文章封面图片
categoryId number 文章类型id
date string 日期
content string 文章内容
state string 已发布,草稿 (为空默认为草稿)

返回数据:

名称 类型 说明
msg string 文字信息 ‘发布成功’ ‘发布失败’

12、根据id获取文章信息

请求地址:/admin/article/search

请求方式:get

请求参数:

名称 类型 说明
id number 文章id

返回数据:

名称 类型 说明
id number 文章id
title string 文章标题
cover file 文章封面图片
categoryId number 文章类型id
date string 日期
content string 文章内容

13、文章编辑

请求地址:/admin/article/edit

请求方式:post

请求参数:

名称 类型 说明
id number 文章id
title string 文章标题
cover file 文章封面图片(可以为空)
categoryId number 文章类型id
date string 日期
content string 文章内容
state string 已发布,草稿 (为空默认为草稿)

返回数据:

名称 类型 说明
msg string 文字信息 ‘修改成功’ ‘修改失败’

14、删除文章

请求地址:/admin/article/delete

请求方式:post

请求参数:

名称 类型 说明
id number 文章id

返回数据:

名称 类型 说明
msg string 文字信息 ‘删除成功’ ‘删除失败’

15、获取统计数据

请求地址:/admin/data/info

请求方式:get

请求参数:无

返回数据:

名称 类型 说明
totalArticle number 文章总数
dayArticle number 日新增文章数
totalComment number 总评论数
dayComment number 日新增评论数

16、日新增文章数量统计

请求地址:/admin/data/article

请求方式:get

请求参数:

返回数据:

{
    "code": 200,
    "msg": "获取成功",
    "date": [
        {
            "date": "2019-05-20",
            "count": 23
        },
        {
            "date": "2019-05-21",
            "count": 19
        },
        {
            "date": "2019-05-22",
            "count": 29
        },
        {
            "date": "2019-05-23",
            "count": 24
        },
        {
            "date": "2019-05-24",
            "count": 28
        },
        {
            "date": "2019-05-25",
            "count": 28
        },
        {
            "date": "2019-05-26",
            "count": 19
        },
        {
            "date": "2019-05-27",
            "count": 25
        },
        {
            "date": "2019-05-28",
            "count": 25
        },
        {
            "date": "2019-7-30",
            "count": 3
        }
    ]
}

17、各类型文章数量统计

请求地址:/admin/data/category

请求方式:get

请求参数:

返回数据:(有多少类型,就返回多少条)

{
    "code": 200,
    "msg": "获取成功",
    "date": [
        {
            "name": "爱旅行",
            "articles": 41
        },
        {
            "name": "爱生活",
            "articles": 72
        },
        {
            "name": "爱美食",
            "articles": 36
        },
        {
            "name": "爱运动",
            "articles": 47
        },
        {
            "name": "经济特区",
            "articles": 33
        }
    ]
}

18、日文章访问量

请求地址:/admin/data/visit

请求方式:get

请求参数:

返回数据:(返回最近1周的,也就是7条)

返回数据结构示例:

{
    "code": 200,
    "msg": "日访问量统计数据获取成功",
    "data": {
        "2019-05-28": 13016,
        "2019-05-27": 11503,
        "2019-05-26": 9128,
        "2019-05-25": 13155,
        "2019-05-24": 12734,
        "2019-05-23": 10714,
        "2019-05-22": 16282
    }
}

19、文章评论搜索

请求地址:/admin/comment/search

请求方式:get

请求参数:

名称 类型 说明
page number 当前页,为空返回第1页
perpage number 每页显示条数,为空默认每页6条

返回数据:

名称 类型 说明
id number 评论id
author string 评论作者
content string 评论内容
aid number 对应文章id
title string 对应文章标题
date string 评论发表时间
state string 评论状态 ‘批准’ ‘待审核’
totalPage number 总页数

20、评论审核通过

请求地址:/admin/comment/pass

请求方式:post

请求参数:

名称 类型 说明
id number 评论id

返回数据:

名称 类型 说明
msg string 文字信息 ‘设置成功’ ‘设置失败’

21、评论审核不通过

请求地址:/admin/comment/reject

请求方式:post

请求参数:

名称 类型 说明
id number 评论id

返回数据:

名称 类型 说明
msg string 文字信息 ‘设置成功’ ‘设置失败’

22、删除评论

请求地址:/admin/comment/delete

请求方式:post

请求参数:

名称 类型 说明
id number 评论id

返回数据:

名称 类型 说明
msg string 文字信息 ‘删除成功’ ‘删除失败’

前台接口

1、文章搜索

请求地址:/index/search

请求方式:get

请求参数:

名称 类型 说明
key string 搜索关键词,可以为空,为空返回某类型所有文章
type string 文章类型id,可以为空,为空返回所有类型文章
page number 当前页,为空返回第1页
perpage number 每页显示条数,为空默认每页6条

返回数据:

名称 类型 说明
pages number 总页数
page number 当前页
data array 文章数据数组,其中每个成员包含字段:
id: number类型,文章id
title: string类型,文章标题
intro: string类型,文章文字内容截取
cover: string类型,文章封面图片地址
category: string类型,文章类型
read: number类型,文章阅读次数
comment: number类型,文章评论次数
date:string类型, 文章发布时间

返回数据结构示例:

{
    "pages":5,
    "page":2,
    "data":[
        {
            "id":1,
            "title":'文章标题文字...',
            "intro":'文章内容文字...',
            "cover":'dfgh/hijk/iui8989.jpg'
            ......
        },
        {
            "id":2,
            "title":'文章标题文字...',
            "intro":'文章内容文字...',
            "cover":'dfgh/hijk/iui8989.jpg'
            ......
        },
        {
            "id":3,
            "title":'文章标题文字...',
            "intro":'文章内容文字...',
            "cover":'dfgh/hijk/iui8989.jpg'
            ......
        }
        ......
    ]
}

2、文章类型

请求地址:/index/category

请求方式:get

请求参数:无

返回数据:

名称 类型 说明
id number类型 类别id
name string类型 类别名称

3、热点图

请求地址:/index/hotpic

请求方式:get

请求参数:无

返回数据:(只返回5条)

名称 类型 说明
id number类型 图片对应文章id
imgurl string类型 图片地址

4、文章热门排行

请求地址:/index/rank

请求方式:get

请求参数:无

返回数据:(只返回7条)

名称 类型 说明
id number类型 文章id
title string 文章标题

5、最新资讯

请求地址:/index/latest

请求方式:get

请求参数:无

返回数据:(只返回5条)

名称 类型 说明
id number类型 文章id
title string类型 文章标题
intro string类型 文章文字内容截取
cover string类型 文章封面图片地址
type string类型 文章类型
read number类型 文章阅读次数
comments number类型 评论条数
date string类型 文章发布时间

6、最新评论

请求地址:/index/latest_comment

请求方式:get

请求参数:无

返回数据:(只返回6条)

名称 类型 说明
author string 用户名称
date string 评论时间
intro string 评论内容截取

7、焦点关注

请求地址:/index/attention

请求方式:get

请求参数:无

返回数据:(只返回7条)

名称 类型 说明
intro string类型 文章内容截取

8、文章详细内容

请求地址:/index/article

请求方式:get

请求参数:

名称 类型 说明
id string 文章id

返回数据:

名称 类型 说明
title string 文章标题
author string 文章作者
type string 文章类型
date string 文章发布时间
read number 阅读次数
comments number 评论条数
content string 文章内容
prev array 上一篇文章
id: 上一篇文章的id
title:上一篇文章的标题
next array 下一篇文章
id: 下一篇文章的id
title:下一篇文章的标题

9、发表评论

请求地址:/index/post_comment

请求方式:post

请求参数:

名称 类型 说明
author string 用户名称
content string 评论内容
articleId number 文章id

返回数据:‘发表成功’ ‘发表失败’

10、评论列表

请求地址:/index/get_comment

请求方式:get

请求参数:

名称 类型 说明
articleId string 文章id

返回数据:

名称 类型 说明
author string 用户名称
date string 评论时间
content string 评论完整内容
Eclipse Public License - v 1.0 THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. 1. DEFINITIONS "Contribution" means: a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor: i) changes to the Program, and ii) additions to the Program; where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program. "Contributor" means any person or entity that distributes the Program. "Licensed Patents" mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program. "Program" means the Contributions distributed in accordance with this Agreement. "Recipient" means anyone who receives the Program under this Agreement, including all Contributors. 2. GRANT OF RIGHTS a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form. b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder. c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program. d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement. 3. REQUIREMENTS A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that: a) it complies with the terms and conditions of this Agreement; and b) its license agreement: i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose; ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits; iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange. When the Program is made available in source code form: a) it must be made available under this Agreement; and b) a copy of this Agreement must be included with each copy of the Program. Contributors may not remove or alter any copyright notices contained within the Program. Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution. 4. COMMERCIAL DISTRIBUTION Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense. For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages. 5. NO WARRANTY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement , including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations. 6. DISCLAIMER OF LIABILITY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 7. GENERAL If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable. If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed. All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive. Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved. This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

简介

新闻项目(前端+后端) 展开 收起
JavaScript 等 3 种语言
EPL-1.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/junmet/BigEventProject.git
git@gitee.com:junmet/BigEventProject.git
junmet
BigEventProject
BigEventProject
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891