该文档的主要目的是帮助用户在线编辑Swagger UI文档。
方法/步骤
1
注册登陆进入'项目管理'
2
点击“更多”中的“新建”创建新项目,然后进入项目详情编辑
3
编辑项目基本信息
4
编辑项目成员通过邮件邀请项目成员,同时可以变更项目成员角色,默认邀请的角色为'访客',目前角色只有“管理员”和“访客”两种,其中只有“管理员”才有编辑权限
5
编辑API文档基本信息
7
编辑数据结构数据结构主要用于固定格式的服务器响应结构,适用于多个接口可能返回相同的数据结构,编辑保存后相关所有的引用都会变更。支持的数据类型说明如下:1、string:字符串类型2、array:数组类型,子项只能是支持的数据类型中的一种,不能添加多个3、object:对象类型,只支持一级属性,不支持嵌套,嵌套可以通过在属性中引入ref类型的对象或自定义数据格式4、int:短整型5、long:长整型6、float:浮点型7、double:浮点型8、decimal:精确到比较高的浮点型9、ref:引用类型,即引用定义好的数据结构
8
接口管理新增接口
9
接口请求参数编辑1、参数位置 body:http请求body cookie:本地cookie formData:表单参数 header:http请求header path:http请求url,如getInfo/{userId} query:http请求拼接,如getInfo?userId={userId}2、参数类型 自定义:目前仅支持自定义json格式,仅当'参数位置'为“body'有效
10
接口响应编辑
上一篇:soso问问怎么点亮图标