以下为《API文档管理和测试》的无排版文字预览，完整格式请下载

下载前请仔细阅读文字预览以及下方图片预览。图片预览是什么样的，下载的文档就是什么样的。

API管理服务器搭建

API 简介

网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。

因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。而API就是完成和前端和后端的交互的地方。这导致API构架的流行，甚至出现"API First"的设计思想。API协议就是前端和后端完成交互时所遵循的规则。目前，RESTful API是比较成熟的一套互联网应用程序的API设计理论。

API接口 组成

接口描述

这个接口是用来干嘛的，以及相关的规则。

接口地址：

以网址的形式展现，你通过发送请求给这个网址来对接口进行交互操作

请求方法：

常用的有GET/POST/DELETE/PUT

请求参数：

请求该接口时，需要提供的参数，参数属性包括名称、类型、是否必填、描述等

返回参数：

接口正常响应后，返回的内容

错误代码：

接口请求失败后，返回的错误代码

RestfulApi的组成

1.2.1 通信协议

API与用户的通信协议，总是使用HTTPs协议。

1.2.2 域名

应该尽量将API部署在专用域名之下。

https://api.bjsxt.com



如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下:

https://bjsxt.com/api/





1.2.3版本

应该将API的版本号放入URL。

https://api.bjsxt.com/v1/



另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。

1.2.4 路径(Endpoint)

路径又称"终点"（endpoint），表示API的具体网址。

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

举例来说，有一个API***（academy）的信息，还包括各种学生和老师的信息，则它的路径应该设计成下面这样。

https://api.bjsxt.com/v1/academies

https://api.bjsxt.com/v1/students

https://api.bjsxt.com/v1/teachers

1.2.5 HTTP动词

对于资源的具体操作类型，由HTTP动词表示。

常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

GET（SELECT）：从服务器取出资源（一项或多项）。

POST（CREATE）：在服务器新建一个资源。

PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。

PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。

DELETE（DELETE）：从服务器删除资源。

还有两个不常用的HTTP动词。

HEAD：获取资源的元数据。

OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

下面是一些例子。

GET /academies：列出***

POST /academies：新建***

GET /academies/ID：获取某个***的信息

PUT /academies/ID：更新某个***的信息（提***的全部信息）

PATCH /academies/ID：更新某个***的信息（提***的部分信息）

DELETE /academies/ID：删除***

GET 内容过长，仅展示头部和尾部部分文字预览，全文请查看图片预览。 noy/yapi \

server/app.js





3.2 YApi的访问

浏览器打开:

http://你的公网ip:3000/



/

可以选择直接使用默认的账号登录，或者是注册一个新的账号。

在这里我选择使用默认的账号登录：

/

/

3.3 CoinExchange接口文档的导入

3.3.1 CoinExchangeAdmin

新建项目：

/

导入数据：

/

选择这个:

/

3.3.2 CoinExchangeUser

新建项目

/

导入数据:

/

选择文件:

/

3.3.3 CoinExchangeExchange

新建项目:

/

导入数据:

/

选择文件:

/

[文章尾部最后300字内容到此结束,中间部分内容请查看底下的图片预览]请点击下方选择您需要的文档下载。

1. 电视台七夕节节目单
2. 清新油菜花ppt模板
3. Python语言实验指导书4(1)
4. 实验二 WWW服务器搭建与测试信息
5. 《Festivals around the wold》核心知识点
6. migrate, emigrate, immigrate课件
7. HTTPS协议简介

以上为《API文档管理和测试》的无排版文字预览，完整格式请下载

下载前请仔细阅读上面文字预览以及下方图片预览。图片预览是什么样的，下载的文档就是什么样的。