使用百家饭API编辑器定义API服务（1）

使用说明

百家饭API编辑器可以从百家饭网站右上角的菜单直接进入。

点击工具菜单，里面的API编辑器，点开就进入了API编辑页面

API编辑器有如下的自带菜单，功能包括以下几个部分：

1. 文件：和OpenAPI编辑内容相关的导入、导出功能
   1. 导入：上传符合OpenAPI v3.1.0以上版本要求的yaml文件，可以直接打开，在编辑器中进行编辑
   2. 导出：将浏览器中编辑的内容导出为标准OpenAPI v3.1.0 Yaml文件
   3. 清空：本编辑器使用本地存储作为存储介质，每隔10秒会进行一次自动保存，如果不需要原来的保存内容，可以选择清空

1. 编辑：编辑API描述信息
2. 测试：测试API
3. 发布：将编辑的API内容发布到平台
4. 关于：编辑器的相关说明信息

编辑功能

本文档主要说明编辑功能，测试功能请参考使用百家饭进行接口测试

开始编辑

点击编辑菜单就可以进入编辑页面，我们首先了解一下接口编辑页面的结构构成

面板的左半边是子功能菜单，右半部是主要编辑区，下方有一个状态条，主要提示当前编辑是否有问题，错误可以点击查看。

基础信息填写

首先我们需要为要编辑的文档起一个名称，并定义他的版本号。按OpenAPI标准要求，名称和版本号都是必填项。注意，OpenApi描述的是一组服务器API接口，不是单个API，因此，我们可以把多个API的结果放到一个文档里。

下方输入对该文档的一些更详细的描述信息。

服务器信息填写

然后可以配置服务器信息

服务器就是API的访问URL，例如我们的接口如果是https://apitest.com/v2/api1,那么服务器可以配置为https://apitest.com/或者https://apitest.com/v2/，当然，这里输入的少了，后面定义API的时候就会多输入一些，因为API的完整信息就是服务器信息和端口信息拼接成的。

所以我们可以根据要公布的API的基本清空，把共性的部分尽量多的放到服务器的信息中来填写。

服务器变量

那服务器变量是做什么用的呢，服务器变量通常用在提供了多个版本的服务器的时候，比如我们同一组服务器，可能提供了测试版本、正式版本，例如

1. 测试版：https://apitest.com/v2/api1
2. 正式版：https://apitest.com/v1/api1

当这些版本变化只是服务器地址不同，那么可以通过服务器变量进行设置，比如上面的两个url就可以配置为

主要的配置点如下：

1. url中使用{version}表明有一个变量（“{}”：用{}括起来的url表示该部分是个变量），名称为version
2. 增加了一个服务器参数，在参数名称中输入了和第一点一样的名称，输入了一个变量描述信息，同时，为了用户调用方便，设置了一个默认值，和一个可选值范围，可选值中列出了所有可能会用到的值。

端口信息填写

定义完服务器之后，我们就可以进一步配置端口信息，端口信息就是具体的端口的url，例如上面的https://apitest.com/v2/api1，在服务器中我们把服务器定义成https://apitest.com/v2/之后，API部分就直接定义为api1就行了，保证这两块信息拼在一起是完整的url地址就可以。

点击添加接口，输入api1，确认即可

每个接口，我们需要进一步定义接口的调用方法，调用方法是http标准的调用方式，点击添加调用方式即可从下拉菜单中选择

下一期我们继续介绍API的定义