设计并实现一个博客网站的REST API

最新推荐文章于 2022-01-24 17:01:34 发布
最新推荐文章于 2022-01-24 17:01:34 发布
阅读量272 收藏
点赞数
文章标签： golang
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/WeiXiaoAssassin/article/details/103208229
版权

设计并实现一个博客网站的REST API

要求：模仿 Github，设计一个博客网站的 API

规范：REST API 设计 Github API v3 overview；微软

文章目录

Github项目地址

Github博客地址

REST简介

REST 是一种基于超媒体构建分布式系统的架构风格。 REST 独立于任何基础协议，并且不一定绑定到 HTTP。 但是，最常见的 REST 实现使用 HTTP 作为应用程序协议 。

HTTP 设计 RESTful API 时的一些主要原则：

  • REST API 围绕资源设计，资源是可由客户端访问的任何类型的对象、数据或服务。
  • 每个资源有一个标识符，即，唯一标识该资源的 URI。
  • 客户端通过交换资源的表示形式来与服务交互。 许多 Web API 使用 JSON 作为交换格式。
  • REST API 使用统一接口，这有助于分离客户端和服务实现。 对于基于 HTTP 构建的 REST API，统一接口包括使用标准 HTTP 谓词对资源执行操作。 最常见的操作是 GET、POST、PUT、PATCH 和 DELETE。
  • REST API 使用无状态请求模型。 HTTP 请求应是独立的并可按任意顺序发生，因此保留请求之间的瞬时状态信息并不可行。 信息的唯一存储位置就在资源内，并且每个请求应是原子操作。
  • REST API 由表示形式中包含的超媒体链接驱动。

Version

Current version

媒体类型版本控制， 当客户端应用程序向 Web 服务器发送 HTTP GET 请求时，它应使用 Accept 标头规定它可以处理的内容的格式。 如果 Accept 标头未指定任何已知的媒体类型，则 Web 服务器可以生成 HTTP 406（不可接受）响应消息或返回使用默认媒体类型的消息。

Accept: application/vnd.adventure-blog.v1+json

这里只是说用这种方式，但是我们只有一个版本，所以在具体代码中不实现该策略。

Users

User Authentication

这里要求每次在申请需要验证用户权限的api时都附上-u，因为不保存session

默认用户admin:admin拥有一切权限

HTTP基本认证

curl -u "username" localhost:7777/api

User Regist

POST localhost:7777/api/users
POSTDESCIPTIONTYPE
username用户名string
password密码string
测试

  • 注册username:WuYongwei password:123的用户

    test

  • 当重复注册时

    test

Get all usernames

GET localhost:7777/api/users
测试

  • 列举所有玩家

    test

Update password

need user authentication

PUT localhost:7777/api/users/username
PUTDESCPRITIONTYPE
newPassword新的密码string
测试

  • 当成功修改时

    test

  • 当原密码输入错误时

    test

  • 当修改密码账户与验证账户不一致时

    test

Delete user

need user authentication

DELETE localhost:7777/api/users/username
测试

  • 删除用户成功

    test

下面的测试将上述删除用户重新添加进去

Blog

Get User Blogs

GET localhost:7777/api/blogs/user/username

该测试是在完成New Blog之后

测试

  • 获取username所写过的博客简介

    test

Get Blog

GET localhost:7777/api/blogs/blogID

该测试是在完成New Blog之后

测试

  • 获取博客详情

    test

New Blog

need user authentication

POST localhost:7777/api/blogs
POSTDESCRIPTIONTYPE
title标题string
content正文string
categories分类（可多个）array of string
测试

  • 提交新博客

    test

Edit Blog

need user authentication

PUT localhost:7777/api/blogs/blogID
PUTDESCRIPTIONTYPE
title标题string
content正文string
categories分类（可多个）array of string
测试

  • 当成功修改时

    test

Delete Blog

need user authentication

DELETE localhost:7777/api/blogs/blogID
测试

test

Category

Get all current categories

GET localhost:7777/api/categories
测试

test

New Category

POST localhost:7777/api/categories
POSTDESCRIPTIONTYPE
categoryName类别名称string
测试

test

Get Category Blog

GET localhost:7777/api/categories/categoryID
测试

test

Update Category name

PUT localhost:7777/api/categories/categoryID
PUTDESCRIPTIONTYPE
categoryName类别名称string
测试

test

Delete Category

need admin authentication

DELETE localhost:7777/api/actegories/categoryID
测试

test14

不足之处

  • 错误处理不够
  • 大量地使用了map，以致数据处理较慢
  • 没有实现异步操作
wywwwwei
关注
博客网站的API设计
lc429716918的博客
11-22 469
设计博客网站的的部分REST API 本篇博客的主要目的是模仿github API，编写设计一个博客网站的部分REST API。 在字博客中使用的博客网站域名为 https://api.MyExampleBlog.com 1.REST REST是Representational State Transfer（表现层状态转移）的缩写，它是由罗伊·菲尔丁（Roy Fielding）提出的，是用来描...
REST API 最佳实践 – REST 端点设计示例
m0_57290114的博客
04-11 3539
在 Web 开发中，REST API 在确保客户端和服务器之间的顺畅通信方面发挥着重要作用。 您可以将客户端视为前端，将服务器视为后端。 客户端（前端）和服务器（后端）之间的通信通常不是超级直接的。因此，我们使用一个称为应用程序编程接口（或API）的接口来充当客户端和服务器之间的中介。 由于 API 在这种客户端-服务器通信中起着至关重要的作用，因此在设计 API 时应始终牢记最佳实践。这有助于维护它们的开发人员以及使用它们的开发人员在执行这些职责时不会遇到问题。 在本文中，我将带您了解在制作 RE
博客网站REST API设计
Zqz983944的博客
11-20 362
博客网站REST API设计 主要功能： 用户注册 用户登录 获取分类列表 创建分类列表 更新分类列表 删除分类 获取分类内文章 获取某个文章 创建文章 更新文章 删除文章 获取评论 发表评论 用户注册 Request POST /api/v1/users Input name type description username string name of the sign...
尝试设计一个博客网站API
Jundesky的博客
11-20 383
文章目录1. 前言2. REST简介3. 设计原则3.1 围绕资源组织 API3.2 根据HTTP方法定义操作3.3 使用一致的数据格式3.4 符合HTTP语义3.5 数据筛选和分页3.6 使用 HATEOAS 导航到相关资源4.设计博客网站的REST API4.1 登陆4.2 查看所有文章4.3 根据关键词查找文章 1. 前言 1.本博客目的是仿造github设计一个博客网站的REST API...
博客网站的REST API设计
HaiRG的博客
11-19 405
博客网站的REST API设计作业题目要求REST API介绍设计一个博客网站的API获取用户所有的博客的摘要获得一篇文章的详细内容获得一篇文章的评论内容更新一篇文章发布一篇文章删除一篇文章获取某月文章认证登陆错误信息 作业题目 博客网站的REST API设计 要求 仿造github设计一个博客网站的REST API REST API介绍 REST是Representational State T...
使用Rest API设计简单的博客网站
sodifferent的博客
11-23 190
博客根地址 https://mygithub.com 对于每个用户自己的博客网站都在这个根地址后加url信息。 使用Rest API进行设计 在这里设计如下API： https://mygithub.com/...(username)/articles https://mygithub.com/...(username)/profile 对于get请求时返回的错误码设计如下： 100 //返...
基于Django REST framework开发一个博客系统（API）.zip
最新发布
09-17
【适合场景】：相关项目设计中，皆可应用在项目开发、毕业设计、课程设计、期末/期中/大作业、工程实训、大创等学科竞赛比赛、初期项目立项、学习/练手等方面中 可借鉴此优质项目实现复刻，也可基于此项目来扩展开发...
powerBI-rest-java:一个简单的API，用于与Java中的PowerBI REST API进行交互
05-10
这个开源项目提供了一个简单的API，允许Java开发者通过RESTful接口与Power BI服务进行交互。REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于HTTP协议，可以轻松地实现客户端...
基于markdown的博客网站Rest API设计
agent0024的博客
11-19 391
本次作业基于markdown编写了一个模仿github api的rest api 数据架构 由于Http是唯一与REST相关的实例，本文的实现通过HTTP实现REST，所有的API访问基于HTTPS进行 访问博客网站的API，https://api.BlogExample.com来进行数据的访问，所有数据通过JSON形式进行发送和接收 资源是Restful API的核心元素，所有的操作...
博客网站API的设计
kjhmh2的博客
11-23 248
博客网站API的设计作业要求REST APIAPI设计用户登录查看某用户发布的所有文章列表查看某用户的所有粉丝查找某文章发布文章删除某篇文章查看某篇文章的评论给某篇文章添加评论给某篇文章点赞 作业要求 仿造github设计一个博客网站的REST API REST API REST是Representational State Transfer，即表现层状态转移的缩写，指的是查看，创建，编辑，删除这...
API设计
AJANEEE的博客
11-17 598
文章目录设计原则基本原则围绕资源组织 API：根据 HTTP 方法定义操作数据筛选和分页使用 HATEOAS 导航到相关资源一个博客网站的APICurrent versionSchema博客摘要博客详细内容认证方式基本认证登录失败参数root客户端错误HTTP verbs分页链接标题限速条件请求 设计原则 基本原则 使用 HTTP 设计 RESTful API 时的一些主要原则： REST A...
怎样更好的设计你的REST API之基于REST架构的Web Service设计及REST框架实现
weixin_34255055的博客
03-06 99
一、REST 含状态传输（英文：Representational State Transfer，简称REST）是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格。 眼下在三种主流的Web服务实现方案中。由于REST模式与复杂的SOAP和XML-RPC相比更加简洁。越来越多的web服务開始採用REST风格设计和实现。比如：Amazon.com提供接近REST...
REST-API--设计简单博客API
big_teacher的博客
01-06 163
要求 仿造github设计一个博客网站的REST API 获取用户所有的articles目录 GET /username/ 获取所有的articles摘要 GET /username/articles 获取指定题目的articles细节 GET /username/articles/title 发布articles使用POST请求 POST /username/articles ...
玩转 ASGI:从零到一实现一个实时博客
ronon77的专栏
06-27 973
最终效果 ASGI 、Django Channels 简介 ASGI 的完整说明我在去年做了一个翻译。ASGI 由 Django 团队提出，为了解决在一个网络框架里（如 Django）同时处理 HTTP、HTTP2、WebSocket 协议。为此，Django 团队开发了 Django Channels 插件，为 Django 带来了 ASGI 能力。在 ASGI 中，将一个网络请求划分...
php服务器响应http请求,php-HTTP请求标头可被本地服务器识别,但不能被在线服务器识别...
weixin_35990295的博客
03-22 145
我制作了一个简单的PHP应用程序,提供了RESTful API,用于注册,登录和更新用户的地理位置.我在本地Apache服务器上使用MySQL数据库进行了测试,一切都很好.最近,我将PHP代码迁移到了在线主机HostGator.当涉及识别HTTP请求标头时,我的部分代码停止工作.像这样：User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWeb...
apiary.io简介——一个API设计网站
魔侠的沙滩
05-01 9536
apiary.io是一个帮助设计API的网站。 API设计时很难得。apiary.io想
REST API 是什么？
qq_27009517的博客
01-24 135
如果你看到这里，你以前可能听说过API 和REST，然后你就会想:“这些都是什么东西？”。也许你已经了解过一些这方面的知识，但却不知道从何入手。在这个教程中，我将会诠释REST的基础以及如何给应用创建一个API（包括认证授权）。 什么是API? API是Application Programming Interface（应用程序接口）的缩写，它是拿来描述一个类库的特征或是如何去运用它。你个人收藏的类库也许包含有可用功能的“API文档”，那些必需的参数我们该怎么称呼它们？诸如此类等等。 然而，如今很
Restful API接口规范
weixin_43992788的博客
10-13 556
简介 REST：英文representational state transfer直译为表现层状态转移，或者表述性状态转移；Rest是web服务的一种架构风格，一种设计风格，是一种思想；同时Rest不是针对某一种编程语言的。 以webService为例通俗解释。 非Rest设计，以往我们都会这么写： http://localhost:8080/admin/getUser （查询用户） http://localhost:8080/admin/addUser （新增用户） http://localhost:80
使用REST API进行数据下载指南
4. "http://www.blogjava.net/flyingis/archive/2007/06/29/126977.html" - 这是一个较旧的博客文章，可能包含了关于REST API的教程或实践案例，对于学习REST API开发有一定帮助。 在使用REST API时，开发者需要...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值