
为此,您将编写以下内容:
1、编写代码
a.添加代码以将专辑数据添加到专辑列表。
在此代码中:
1)用于Context.BindJSON 将请求正文绑定到newAlbum。
2) album将从 JSON 初始化的结构附加到albums 切片。
3)向响应添加201状态代码,以及表示您添加的专辑的 JSON。
b.更改您的main函数,使其包含该router.POST函数,如下所示。
在此代码中:
1)将路径中的POST方法与 /albumspostAlbums函数相关联。
使用 Gin,您可以将处理程序与 HTTP 方法和路径组合相关联。这样,您可以根据客户端使用的方法将发送到单个路径的请求单独路由。
a.如果服务器从上一节开始仍在运行,请停止它。
b.从包含 main.go 的目录中的命令行,运行代码。
c.从不同的命令行窗口,用于curl向正在运行的 Web 服务发出请求。
该命令应显示添加专辑的标题和 JSON。
d.与上一节一样,使用curl检索完整的专辑列表,您可以使用它来确认添加了新专辑。
该命令应显示专辑列表。
当客户端向 发出请求时GET /albums/[id],您希望返回 ID 与id路径参数匹配的专辑。
为此,您将:
a.在您在上一节中添加的函数下方postAlbums,粘贴以下代码以检索特定专辑。
此getAlbumByID函数将提取请求路径中的 ID,然后找到匹配的专辑。
在此代码中:
(1)Context.Param用于从 URL 中检索id路径参数。当您将此处理程序映射到路径时,您将在路径中包含参数的占位符。
(2)循环album切片中的结构,寻找其ID 字段值与id参数值匹配的结构。如果找到,则将该album结构序列化为 JSON,并将其作为带有200 OK HTTP 代码的响应返回。
如上所述,实际使用中的服务可能会使用数据库查询来执行此查找。
(3)如果找不到专辑,则返回 HTTP 404错误。
b.最后,更改您的main,使其包含对router.GET的新调用,路径现在为/albums/:id ,如以下示例所示。
在此代码中:
(1)将/albums/:id路径与getAlbumByID功能相关联。在 Gin 中,路径中项目前面的冒号表示该项目是路径参数。
a.如果服务器从上一节开始仍在运行,请停止它。
b.在包含 main.go 的目录中的命令行中,运行代码以启动服务器。
c.从不同的命令行窗口,用于curl向正在运行的 Web 服务发出请求。
该命令应显示您使用其 ID 的专辑的 JSON。如果找不到专辑,您将收到带有错误消息的 JSON。
恭喜!您刚刚使用 Go 和 Gin 编写了一个简单的 RESTful Web 服务。
本节包含您使用本教程构建的应用程序的代码。
基本上是个python的web框架都可以写,简单的有bottle、webpy等,高并发性能的tornado、twisted等。具体例子你查查rest风格的数据接口,比如用户用get方法获得html *** 作界面,post方法发送商品名称、年月等信息返回json查询结果等。用户注册和登录信息存在session里。网页微信同时利用一个后台。
说白了就是个最简单的动态网站,只涉及数据库和session。
你要是新手,看看python bottle的例子就好,关注数据库和session的实现,一天就能学会,为了提高并发可以使用gevent,配合写个脚本多进程运行,将就用是没问题的。想提高并发性能,以后抽空学下tornado,没啥难度。。。
基于目前的大前端时代,对于常年负责后台开发的我来说, 最重要的就是提供稳定的接口和文档。便于小伙伴们进行业务对接。
当下常用的是RestFul风格的定义规范, 之前开发是清一色Get、Post。引入RestFul后感觉接口定义规范很多,看接口地址就知晓是什么功能, 一起来看看列的一些基础规范吧。
API与客户端用户的通信协议,总是使用HTTPS协议,以确保交互数据的传输安全。
应该尽量将API部署在专用域名之下: https://api.example.com
如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下: https://www.example.com/api
https://api.example.com/v{n}
1、应该将API的版本号放入URL。
2、采用多版本并存,增量发布的方式。
3、n代表版本号,分为整型和浮点型
整型: 大功能版本, 如v1、v2、v3 ...
浮点型: 补充功能版本, 如v1.1、v1.2、v2.1、v2.2 ...
4、对于一个 API 或服务,应在生产中最多保留 3 个最详细的版本
路径又称"终点"(end point),表示API的具体网址。
1、在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词。
【所用的名词往往与数据库的表格名对应】
2、数据库中的表一般都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。
例子: https://api.example.com/v1/products
https://api.example.com/v1/users
https://api.example.com/v1/employees
GET(SELECT): 从服务器取出资源(一项或多项)。
POST(CREATE): 在服务器新建一个资源。
PUT(UPDATE): 在服务器更新资源(客户端提供改变后的完整资源)。
DELETE(DELETE): 从服务器删除资源。
例子:
GET /v1/products 获取所有商品
GET /v1/products/ID 获取某个指定商品的信息
POST /v1/products 新建一个商品
PUT /v1/products/ID 更新某个指定商品的信息
DELETE /v1/products/ID 删除某个商品,更合理的设计详见【9、非RESTful API的需求】
GET /v1/products/ID/purchases 列出某个指定商品的所有投资者
GET /v1/products/ID/purchases/ID 获取某个指定商品的指定投资者信息
若记录数量很多,服务器不可能返回全部记录给用户。
API应该提供分页参数及其它筛选参数,过滤返回结果。
/v1/products?page=1&pageSize=20 指定第几页,以及每页的记录数。
/v1/products?sortBy=name&order=asc 指定返回结果按照哪个属性排序,以及排序顺序。
传入参数分为4种类型:
1、cookie: 一般用于OAuth认证
2、request header: 一般用于OAuth认证
3、请求body数据:
4、地址栏参数:
1)restful 地址栏参数 /v1/products/ID ID为产品编号,获取产品编号为ID的信息
2)get方式的查询字段 见【六、过滤信息】
response:
----------------------------------------
{
status: 200, // 详见【status】
data: {
code: 1, // 详见【code】
data: {} || [], // 数据
message: '成功', // 存放响应信息提示,显示给客户端用户【须语义化中文提示】
sysMessage: 'success' // 存放响应信息提示,调试使用,中英文都行
... // 其它参数,如 total【总记录数】等
},
msg: '成功', // 存放响应信息提示,显示给客户端用户【须语义化中文提示】
sysMsg: 'success' // 存放响应信息提示,调试使用,中英文都行
}
----------------------------------------
【status】:
200: OK 400: Bad Request 500:Internal Server Error
401:Unauthorized
403:Forbidden
404:Not Found
【code】:
1: 获取数据成功 | *** 作成功 0:获取数据失败 | *** 作失败
1、实际业务开展过程中,可能会出现各种的api不是简单的restful 规范能实现的。
2、需要有一些api突破restful规范原则。
3、特别是移动互联网的api设计,更需要有一些特定的api来优化数据请求的交互。
1)、删除单个 | 批量删除 : DELETE /v1/product body参数{ids:[]}
2)、页面级API : 把当前页面中需要用到的所有数据通过一个接口一次性返回全部数据
1、前端需要哪些字段,API接口应该返回哪些字段,字段不多也不少。
2、更新功能尽量做到:初次返回的原始数据参数与提交更新的数据参数结构一致。
3、时间参数,尽量以一致格式的字符串传递, 如:
‘2019-01’ | ‘2019/01’
‘2019-01-01’ | ‘2019/01/01’
‘2019-01-01 12:12:12’ | ‘2019/01/01 12:12:12’
1、尽量采用自动化接口文档,可以做到在线测试,同步更新。
2、应包含:接口BASE地址、接口版本、接口模块分类等。
3、每个接口应包含:
接口地址:不包含接口BASE地址。
请求方式: get、post、put、delete等。
请求参数:数据格式【默认JSON、可选form data】、数据类型、是否必填、中文描述。
相应参数:类型、中文描述。
欢迎分享,转载请注明来源:内存溢出
微信扫一扫
支付宝扫一扫
评论列表(0条)