服务计算：模仿 Github，设计一个博客网站的 API

最新推荐文章于 2024-07-19 00:55:10 发布
最新推荐文章于 2024-07-19 00:55:10 发布
阅读量180 收藏
点赞数
分类专栏： IT相关 学习之路
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/huangshm23/article/details/103217572
版权

总览

1. 博客网站应该具有的基本能力

  • 个人介绍 对于个人博客来说，它首先要支持展示博主的个人介绍。这个个人介绍里面可能包括了昵称、联系方式、相关经历等基本内容，能够让读者能够对这个博客的主人有一个基本的认识。
  • 文章的撰写与展示 对一个博客来说，最重要的就是它的内容，也就是里面的文章。一个好用的博客平台应该具备易于让博主撰写文章的能力，让够让博主毫无负担地撰写、编辑自己的文章。此外，还必须能够有层次，条理的展示文章的信息，比如展示标题、节选、封面，创建 /修改时间，评论点赞数等等。
  • 归档能力 一篇文章的撰写时间、内容标签 /分类等都是不同的，如何按照不同的要求对这些文章进行归档整理，也是考验博客平台的能力之一。而当文章数量较多的时候，添加一个搜索的功能也能大大方便读者对某博主博客的浏览。
  • 博主与读者互动的能力 仅仅只有博主一个人自嗨可能难以激发写作的动力，如果博客能够提供博主与读者互动的能力，将能有效激励博主持续创作，更能提升文章的传播度——点赞和评论功能则是互动能力中最重要的功能之一。

2. RESTful风格

  1. RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务使能接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。
  2. 特点：
    a. 每一个URI代表1种资源；
    b. 客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源；
    c. 通过操作资源的表现形式来操作资源；
    d. 资源的表现形式是XML或者HTML；
    e. 客户端与服务端之间的交互在请求之间是无状态的，从客户端到服务端的每个请求都必须包含理解请求所必需的信息。

3. 基本规则

1）通信协议：API与用户的通信协议，总是使用HTTPs协议。
2）数据格式：统一采用JSON。
3）URI格式统一：同一作者发布另一篇博文，则仅仅改变URI后面的部分，URI的前面部分不应改变。
4）状态码：统一根据HTTP协议：

  • 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
  • 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
  • 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
  • 204 NO CONTENT - [DELETE]：用户删除数据成功。
  • 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
  • 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
  • 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
  • 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
  • 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
  • 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
  • 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
  • 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

4. 设计博客网站的REST API

4.1 查看当前版本

默认情况下，所有https://api.weblog.com接收当前版本（V1）的REST API的请求。

Accept:application/vnd.weblog.v1+json

注：所有的时间戳都以ISO 8601格式返回：

YYYY-MM-DDTHH:MM:SSZ

4.2 用户登录

curl -u username -p password https://weblog.com/v1

登录成功：返回状态码为：2xx
登录失败：返回状态码为：4xx

注：以下API均在登录的情况下使用。

4.3 查看用户信息

GET /username

curl -u https://weblog.com/v1/huangshim23

响应：

{
	Status：200 OK
	----------------
	"username":huangshim23.
	"age":20,
	"gender": man,
	"fans":null,
	"coin":0,
	"interestring field":Computing Service,3D,
	"created_at":2017-10-01T14:20:35+08:00
}

4.4 修改用户信息

PUT /user

data //修改用户的参数
{
	"age": 21,
	...
}
    
curl -u -d {"age": 21, ...} https://weblog.com/v1/huangshim23

响应：

{
	Status：200 OK
	----------------
	"username":huangshim23.
	"age":21,
	"gender": man,
	"fans":null,
	"coin":0,
	"interestring field":Computing Service,3D,
	"created_at":2017-10-01T14:20:35+08:00
}

4.5 查看文章

1）查看用户发表的所有文章

GET /username/articles

curl -a https://weblog.com/v1/huangshim23/articles

响应：

{
  "username":"huangshim23"
  "total_num":20,
  "articles":[
    {
      "title":"title1",
      "id": 1,
      "href":"https://weblog.com/v1/huangshim23/articles/1",
      "action":"GET",
      "status":"original"
      "created_time": "2010-11-11T17:31:50Z",
      "updated_time": "2014-11-11T17:58:47Z",
      "words": 3000,
      "visits": 1000
    },
    {
      "title":"title2",
      "id": 1,
      "href":"https://weblog.com/v1/huangshim23/articles/2",
      "action":"GET",
      "status":"reproduced"
      "created_time": "2016-11-21T17:31:50Z",
      "updated_time": "2018-08-11T17:58:47Z",
      "words": 5000,
      "visits": 10
    },
    ...
   ]
}

2）查看特定的文章

GET /username/articles/{id}
GET /username/articles/{title}

curl -u https://weblog.com/v1/huangshim23/articles/1
curl -u https://weblog.com/v1/huangshim23/articles/hello-world

响应：

{
  "username": huangshim23,
  "title":"hello-world",
  "id": 1,
  "href":"https://weblog.com/v1/huangshim23/articles/1",
  "action":"GET",
  "status":"original"
  "created_time": "2016-11-21T17:31:50Z",
  "updated_time": "2018-08-11T17:58:47Z",
  "words": 3000,
  "visits": 1000
}

4.6 发布文章

POST /user/articles

data //发布文章的数据参数
{
	"title":
	"content":
	"description":
	"visibility":
	"status":
}
curl -u -p -d '{"title":"xxx","content":"xxx","description":"xxxx","visibility":true, "status": "orginal"}' https://weblog.com/v1/huangshim23/articles

响应：

Status：200 OK
--------------------------
	"isPublished":true ,
	"article":{
      "id": 3,
      "title": "articleTitle",
      "owner": {
        "name": "haungshim23",
        "id": 123,
        "url": "https://weblog.com/v1/huangshim23",
        "type": "User"
      },
      "article_url": "https://weblog.com/v1/huangshim23/articles/3",
      "private": false,
      "description": "...",
      "reading number": 1,
      "created_at": "2016-11-11T17:31:50Z",
      "updated_at": "2016-11-11T17:31:50Z",
      "words": 1502,
      "language": "Chinese",
      "content":"article contents...."
    }
}

4.7 删除文章

DELETE /user/articles/id

curl -d -i https://weblog.com/v1/huangshim23/articles/1

响应：

Status：200 OK
--------------------------
{
"successed": "true",
"article_id": "1",
"created_at":"2019-09-01T11:30:50Z",
"deleted_at": "2019-11-20T10:30:50Z"
}

4.8 查看文章评论

GET /user/articles/id/comments

curl -u https://weblog.com/v1/huangshim23/articles/1/comments

响应：

{
Status：200 OK
--------------------------
"comments":[
    {
      "userName":"user1",
      "comment": "...",
      "comment_time":"2019-11-11T10:30:50Z",
      "stars": 100
    },
    {
      "userName":"user2",
      "comment": "...",
      "comment_time":"2019-11-21T12:30:20Z",
      "stars": 1
    },
    ...
   ]
}

4.9 发布文章评论

POST /user/articles/id/comments

curl  -c '评论内容' https://weblog.com/v1/huangshim23/articles/1/comments

响应：

{
"comment_status": "succeeded",
"comment": "评论内容",
"userName": "huangshim23",
"comment_time": "2019-11-21T12:30:20Z"
}
huangshm23
关注
专栏目录
类似github代码提交代码活跃图实现
weixin_42994352的博客
07-08 2193
最近，项目中有这样一个需求，想实现类似github代码提交记录这样的一个热力图的功能 第一个想法是看echart有没有类似的功能，确实有类似的一个热力图 但是，我不太想用这个热力图，想看看有没有专门的插件可用，真的被我找到了一个vue-calendar-heatmap 使用方法如下： 下载插件 npm install --save vue-calendar-heatmap 使用： 方法一：全局注册 import Vue from 'vue' import VueCalendarHeatmap from
自定义View:仿GitHub的提交活跃表格
Hello, world
01-17 7407
说明本文可能需要一些基础知识点，如Canvas,Paint，Path，Rect等类的基本使用，建议不熟悉的同学可以学习GcsSloop安卓自定义View教程目录，会帮助很大。 上图就是github的提交表格，直观来看可以分为几个部分进行绘制： （1）各个月份的小方格子，并且色彩根据提交次数变化，由浅到深 （2）右下边的颜色标志，我们右对齐就可以了 （3）左边的星期，原图是从周日画到周六，我们
模仿 Github，设计一个博客网站的 API
J_neng的博客
11-23 320
模仿 Github 设计一个博客网站的 API
服务计算：模仿 Github设计一个博客网站的 API
qq_39681297的博客
11-24 191
REST 和 API 介绍 REST 在 2000 年，Roy Fielding 提议使用表述性状态转移 (REST) 作为设计 Web 服务的体系性方法。 REST 是一种基于超媒体构建分布式系统的架构风格。 REST 独立于任何基础协议，并且不一定绑定到 HTTP。 但是，最常见的 REST 实现使用 HTTP 作为应用程序协议，本指南重点介绍如何设计适用于 HTTP 的 REST API。...
服务计算 模仿 Github API 简单设计一个博客 API
ShiYiloo_的博客
11-25 289
模仿 Github API 简单设计一个博客网站的 API REST 是一种基于超媒体构建分布式系统的架构风格。 REST 独立于任何基础协议，并且不一定绑定到 HTTP。 REST API 设计原则 REST API 围绕资源设计，资源是可由客户端访问的任何类型的对象、数据或服务。 每个资源有一个标识符，即唯一标识该资源的 URI。 客户端通过交换资源的表示形式来与服务交互。 许多 Web A...
模仿 Github 设计博客网站的 API
abc15837998448的博客
11-23 564
一、 作业要求 模仿 Github，设计一个博客网站的 API REST API 的设计原则 HTTP 协议定义了大量为请求赋于语义的方法。API访问都是通过HTTPS协议进行的，并通过https://api.blog.com进行访问，数据以JSON的形式发送和接收 使用 HTTP 设计 RESTful API 时的一些主要原则： REST API 围绕资源设计，资源是可由客户端访问的任何类型...
服务计算——模仿GithubAPI编写设计一个博客网站的部分RESTAPI
weixin_37863947的博客
11-19 574
Web API 参考博客链接 Overwview WebAPI - API的概念 - Web API的概念 DOM - DOM的概念 - DOM经常进行的操作 获取页面元素 - 为什么要获取页面元素 事件 - 事件三要素 - 事件的基本使用 属性 - 非表单元素的属性 - 表单元素属性 - 案例 - 自定义属性操作 - 样式操作 - 类名操作 - 案例 创建元素的三种方式 -...
【服务计算】REST API学习与设计——模仿GithubAPI设计博客网站API
JKJKL1的博客
11-23 251
什么是REST？ REST：全称Representational State Transferer，是Roy Fielding博士在他的博士论文中提出来的一种软件架构风格。注意它是一种风格，而不是某个标准或者某个框架。但是根据这中定义的风格编写Web程序，就会得到一个比较优质的系统。 好，回到REST的理解上，将其名字翻译过来是“表示层状态转移”，很难理解。不妨试着在这个短语前加上一个名词，Res...
服务计算--模仿github API用markdown编写设计一个博客网站的部分rest API
TempterCyn的博客
11-20 321
当前版本 默认情况下，所有https://api.myblog.com接收v1 版本的REST API的请求。我们建议您通过Accept明确请求此版本。 Accept: application/vnd.myblog.v1+json 模式 所有API访问都是通过HTTPS进行的，并且可以通过访问https://api.github.com。所有数据都以JSON的形式发送和接收。 curl -i ...
awesome-CARLA：:backhand_index_pointing_right:CARLA资源，例如教程，博客，代码等https：//github.comcarla-simulatorcarla
02-02
**CARLA（Car Learning to Act）** 是一个开源模拟器，专为自动驾驶研究而设计。它提供了高度可配置的环境，允许研究人员测试和验证自动驾驶算法，同时也支持深度学习、计算机视觉和强化学习等多个领域的研究。 **...
GitHub上最受欢迎的57个深度学习开源项目
02-28
Keras是一个高级神经网络API，编写于Python语言，并能在TensorFlow或Theano之上运行。Keras设计的主要目标是用户友好、模块化以及易于扩展。它支持快速原型设计，即用户可以迅速构建和测试新模型。Keras还提供了大量...
AI人工智能深度学习算法：面向服务计算中的深度学习代理工作流管理
最新发布
程序员光剑
07-19 952
随着互联网技术的飞速发展以及云计算平台的普及，服务计算成为支撑现代业务运行的核心框架之一。服务计算涉及到众多服务的动态组合、调度与管理，以满足多样化的业务需求。然而，随着服务数量的增加和业务需求的复杂性，手动管理和优化服务组合变得越来越困难。在此背景下，引入人工智能和深度学习技术，特别是深度学习算法，来自动管理和优化服务工作流成为了一个极具吸引力的方向。深度学习代理工作流管理：指的是利用深度学习技术自动管理和优化服务工作流的过程。
简单博客网站API设计
qq_20549085的博客
11-20 235
简单博客网站API设计 前言 这是中山大学数据科学与计算机学院2019年服务计算的作业项目。所有代码与博客将被上传至github当中。 Github项目地址: https://github.com/StarashZero/ServerComputing/tree/master/hw6 个人主页: https://starashzero.github.io 作业简介 模仿 Github，设计一个博客...
让你的计算机也能提供云桌面服务：搭建私有云
huangshm23的博客
09-01 1247
这里写自定义目录标题1、实验目的2、实验环境3、实验内容及过程实验参考博客： 1、实验目的 初步了解虚拟化技术，理解云计算的相关概念 理解系统工程师面临的困境 理解自动化安装、管理（DevOps）在云应用中的重要性 2、实验环境 用户通过互联网，使用微软远程桌面，远程访问你在PC机上创建的虚拟机 虚拟机操作系统 Centos，Ubuntu，或 你喜欢的 Linux 发行版，能使用 NAT 访...
易语言
huangshm23的博客
12-11 451
通过汉语进行编程的易语言
文章标题
huangshm23的博客
12-03 448
大数据技术与伦理近年来，在人们热烈讨论的话题中频繁出现大数据技术这个话题，那到底什么是大数据，又什么是大数据技术呢？以下是某些大众比较认可的大数据定义： 360百科：大数据(big data,mega data)，或称巨量资料，指的是需要新处理模式才能具有更强的决策力、洞察力和流程优化能力的海量、高增长率和多样化的信息资产。 在维克托·迈尔-舍恩伯格及肯尼斯·库克耶编写的《大数据时代》中大数据指不用
Centos7 安装go语言开发环境
huangshm23的博客
09-11 380
文章目录1、安装 VSCode 编辑器2、安装 golang2.1 安装2.2 设置环境变量2.3 创建hello world！3、安装必要的工具和插件3.1 安装Git客户端3.2 安装go的一些工具4、安装与运行go tour5、第一个包 1、安装 VSCode 编辑器 参考官方网站，按照下面命令进行安装： 首先进行安装包的下载： sudo rpm --import https://pac...
3D游戏设计 homework3
huangshm23的博客
09-21 327
文章目录1、简答并用程序验证1.1 游戏对象运动的本质是什么？1.2 请用三种方法以上方法，实现物体的抛物线运动。（如，修改Transform属性，使用向量Vector3的方法…）1.3 写一个程序，实现一个完整的太阳系， 其他星球围绕太阳的转速必须不一样，且不在一个法平面上。2、编程实践（1）列出游戏中提及的事物（Objects）：（2）用表格列出玩家动作表（规则表），注意，动作越少越好（3）请...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值