多应用+插件架构,代码干净,二开方便,首家独创一键云编译技术,文档视频完善,免费商用码云13.8K 广告
我们再次点开info这个接口,来详细的给大家说明下如何去编辑一个接口 ![](https://box.kancloud.cn/4e764fa07ba6026cee1ea6deb3e8b857_2082x1188.png) 上图中接口编辑页面可以分为三个部分:接口的基本信息,接口快照,接口的参数信息。 ### 基本信息: **名称:** 接口的名称 ![](https://box.kancloud.cn/39dcea5bffe95153e903ff72322b7a6f_978x320.png) 这里表示接口的创建者创建时间,最后操作者和操作时间 **保存:** 点击保存,该接口的数据会被保存下来 **运行:** 点击运行,可以调试该接口的数据 **预览:** 点击预览,会切换到文字版本的展示页面 **路径:** 这里可以填入接口的路径地址,路径不包含baseUrl,baseUrl请前往左边全局标签页里面设置。例如http://abc.com/login, http://abc.com 是baseUrl,这里输入/login即可,支持restful url形式,例如:/info/{name} 支持路径参数的粘贴,系统会自动识别路径和query参数 **方法:** 支持GET,POST,PUT,DELETE,PATCH五种http方法 **分组:** 接口所在的分组 **状态:** 分为开发中,开发完成,已废弃,具体使用会在Mock数据里面做详细解释。 **分享:** 这个链接可以分享给没有注册DOClever的用户,他们通过这个链接打开的就是这个接口的预览界面。 **简介:** 就是关于这个接口的描述 ### 快照 快照我们会在版本管理-接口快照里做详解! ### 参数信息 对于很多接口,不同的入参会返回不同的出参,所以在DOClever里面,可以有多个入参出参的配对,每个配对可以称为一个参数实例。 ![](https://box.kancloud.cn/d0bf91ec69a0916dde76e9d00f822971_2058x980.png) 上图中未命名就是一个参数实例,我们可以点击右边的加号来添加多个实例 **Param:** 当我们在路径里面填写含有restful形式的url时,比如:/user/info/{id},DOClever会自动解析路径,并且提供对param参数的支持,如下图 ![](https://box.kancloud.cn/e8a2320a8d2b00d77f93081610fd6187_1994x1130.png) **Query:** 这里代表的含义类似于http://aaa.com/user?name=sx&pass=111 这个地址中的name=sx&pass=111这样的参数,我们需要填入的是参数名称,参数是否必选,备注,参考值。点击未填值,弹出如下图所示: ![](https://box.kancloud.cn/d261e025c4e4c18bba2f1e22f820de22_1410x506.png) 填入该参数的参考值和备注,点击保存 **Header:** 这里的含义代表我们发送该请求的自定义http头部 **Body:** 当我们切换http method到post,put或者patch的时候,会出现Body这个标签页,我们切换到这个标签页,如下图: ![](https://box.kancloud.cn/6aa40507806ef8207f88ce64dce66bad_1940x424.png) 这里分为两种模式,一种是以键值对形式(key-value),还有一种是把数据直接传给http body(raw),当Header里面的content-type为空或者为application/x-www-form-urlencoded,multipart/form-data的时候,DOClever会切换为key-value的形式,其他情况会切换为raw。 key-value:值得注意的是参数类型,可以有文本和文件两种,当选择文件的时候,DOClever会切换到multipart/form-data的方式发送数据。 raw:我们可以现在不同的数据类型,选择不同的类型header里面的content-type也会发生相应的变化,当现在JSON的时候,会出现如下图所示的界面: ![](https://box.kancloud.cn/dbadee6dddf080b7869525c14a7a6a58_1950x310.png) JSON的具体操作会在出参里面做具体讲解 **Inject:** 这一部分在注入里面做详细讲解 **Result:** 这里代表的是出参的数据模型,出参也分为两种,JSON,RAW。 JSON:这里又分为Object和Array两种类型,Object代表返回的是一个json对象,Array代表返回的是一个json数组,参数字段从左到右依次为名称,类型,是否必有,备注,Mock或者参考值,删除按钮,新增按钮,这里值得注意的是类型,在DOCLever里面,json的类型有六种:String,Number,Boolean,Array,Object,Mixed,前五种都好理解,最后一种Mixed代表的是任意类型,当我们的参数类型不定的时候,就可以用Mixed来代替。当参数的类型为Array或者Object的时候,我们可以为该字段添加子字段,拖动该字段,我们还可以改变字段的顺序,或者父子关系。 ![](https://box.kancloud.cn/e4bd0b38ba908b85fc9a1570137ccab4_1964x1244.png) RAW:如果返回的是其他类型的数据,就可以在RAW标签页里面填入相关的信息。 ![](https://box.kancloud.cn/07cd355ad1436ab107e52849664f2245_2024x420.png)