Yapi接口文档（部分）

最新推荐文章于 2024-04-22 17:19:03 发布
最新推荐文章于 2024-04-22 17:19:03 发布
阅读量2.5k 收藏 3
点赞数
分类专栏： yapi 文章标签： 接口 restful java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_38366743/article/details/103558779
版权

Yapi接口文档

1.分组

分组列表

URL

/api/group/list
HTTP请求方式

GET

请求参数
参数必选类型说明
新增分组

URL

/api/group/add
HTTP请求方式

POST

请求参数
{
    "group_name":"aaa",  必填
    "group_desc":"aaa",
    "owner_uids":["27"]
}
修改分组

URL

/api/group/up
HTTP请求方式

POST

请求参数
{
    "group_name":"aaaa",
    "group_desc":"aaa",
    "custom_field1":{"enable":false},
    "id":155
}
删除分组

URL

/api/project/del
HTTP请求方式

POST

请求参数
body:
{
	"id": 233
}
分组动态

URL

/api/log/list
HTTP请求方式

GET

请求参数
参数必选类型说明
typeidtrueString分组ID
typetrueString类型
limitString
page
http://172.28.96.254:3000/api/log/list?typeid=155&type=group&page=1&limit=10

2.项目

项目列表

URL

/api/project/list
HTTP请求方式

GET

请求参数
参数必选类型说明
group_idtrueString分组ID
pageString
limitString
新增项目

URL

/api/project/add
HTTP请求方式

POST

请求参数
{
    "name":"passdemo1",
 	"basepath":"/passdemo",
    "desc":"pass",
    "group_id":"131",
    "icon":"code-o",
    "color":"yellow",
    "project_type":"private"
}
修改项目

URL

/api/project/up
HTTP请求方式

POST

请求参数
{
  "name":"passdemo1",
  "project_type":"private",
    "basepath":"/passdemo",
    "switch_notice":true,
    "desc":"passss",
    "id":235,
    "env":[
        {"header":[],
         "global":[],  					              
         "_id":"5d849218026c803516da1393",
         "name":"local",
       "domain":"http://127.0.0.1"
        }
    ],
    "group_id":"131",
    "strice":false,
    "is_json5":false,
    "tag":[]
}
删除项目

URL

/api/project/del
HTTP请求方式

POST

请求参数

3.成员

组成员列表

URL

/api/group/get_member_list
HTTP请求方式

GET

请求参数
参数必选类型说明
idtrueString分组ID
项目成员列表

URL

/api/project/get_member_list
HTTP请求方式

GET

请求参数
参数必选类型说明
idtrueString项目ID
组添加成员

URL

/api/group/add_member
HTTP请求方式

POST

{
    "id":131,   组Id 
    "member_uids":["27"],   用户ID
    "role":"dev"    角色
}
项目添加成员

URL

/api/project/add_member
HTTP请求方式

POST

{
    "id":235,   项目Id 
    "member_uids":["67"],   用户ID
    "role":"dev"    角色
}
组删除成员

URL

/api/group/del_member
HTTP请求方式

POST

{"id":131,"member_uid":27}
项目删除成员

URL

/api/project/del_member
HTTP请求方式

POST

{"id":"235","member_uid":27}
修改成员权限

URL

/api/group/change_member_role
HTTP请求方式

POST

{"id":131,"member_uid":"27","role":"guest"}
修改项目成员权限

URL

/api/project/change_member_role
HTTP请求方式

POST

{"id":"235","member_uid":"59","role":"dev"}

4.搜索

搜索分组/项目/

URL

/api/project/search?q=qqq
HTTP请求方式

GET

参数：q
用户搜索

URL

/api/user/search?q=1
HTTP请求方式

GET

参数：q

5.动态

动态

URL

/api/log/list
HTTP请求方式

GET

参数：?typeid=147   true          类型ID(分组ID,项目ID)
&type=group        true          类型
&page=1&                    分页
limit=10 
selectValue               搜索API名称

6.设置

环境配置

URL

/api/project/up_env
HTTP请求方式

POST

{
    "id":235,"env":		 
    [
         {
       "_id":"5d849218026c803516da1393",
             "name":"local",
             "domain":"http://127.0.0.1",
             "header":
             [
                 {
                     "name":"Accept-Language",
                     "value":"aaa"
                 },
                 {
                     "name":"Cookie",
                     "value":"cookie=123"
                 }
             ],
             "global":[
                 {
                 "name":"aa",
                 "value":"aa"
                 }
             ]
         }
    ]
}
请求配置

URL
HTTP请求方式

GET
Tag配置

URL

/api/project/up_tag
HTTP请求方式

POST

{
    "id":235,
    "tag":[
        {
        "name":"aaa",
        "desc":"aaa"
         },
         {
             "name":"aaab",
             "desc":"bbbb"
         }
    ]
}
全局mock脚本

URL
HTTP请求方式

GET

6.接口

分类列表

URL

/api/interface/list_menu?project_id=239
HTTP请求方式

GET

project_id=239
添加分类

URL

/api/interface/add_cat
HTTP请求方式

POST

{"name":"aaa","desc":"aaa","project_id":"235"}
修改分类

URL

/api/interface/up_cat
HTTP请求方式

POST

{"catid":4925,"name":"csadd11","desc":"csadd11"}
删除分类

URL

/api/interface/del_cat
HTTP请求方式

POST

{"catid":4895}
接口列表

URL

/api/interface/list_cat?page=1&limit=20&catid=4913
HTTP请求方式

GET

page=1&limit=20&catid=4913
新增接口

URL

/api/interface/add
HTTP请求方式

POST

{"method":"GET","catid":"4901","title":"aaacs","path":"/ccc","project_id":"235"}
接口编辑

URL

/api/interface/up
HTTP请求方式

POST

{
    "req_query":[
        {
            "name":"user",
            "required":"1",
            "example":"add",
            "desc":"用户名"
        }
    ],
    "req_headers":[],
    "req_body_form":[],
    "title":"aaacs",
    "catid":"4901",
    "path":"/ccc",
    "tag":["aaa"],
    "status":"undone",
    "req_body_is_json_schema":true,
    "res_body_is_json_schema":true,
    "res_body_type":"json",
    "res_body":
    "{\"type\":\"object\",\"title\":\"empty object\",\"properties\":{},\"description\":\"sss\"}",
    "switch_notice":true,
    "api_opened":false,
    "desc":"<p>asdasd</p>\n",
    "markdown":"asdasd",
    "method":"GET",
    "req_params":[],
    "id":"8057"
}
删除接口

URL

/api/interface/del
HTTP请求方式

POST

{"id":8057}
AiDd124
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
yapi自动化接口操作
qq_20619857的博客
06-16 2922
打开yapi新建项目新建空间，选择要操作的空间，点击【新建项目】，选择对应项目。到swagger下载json文件到相应的项目里面点击【数据管理】》【json】将下载的api导入。点击【接口】新建获取token接口，在编辑输入对应的参数，请求方法和参数可以在浏览器开发工具F12查看。要点击【保存】，否则输入数据不保存。在运行中点击【发送】，如果返回数据成功，点击【保存】到测试集合方便进行自动化测试。以下的接口进行上面，编辑》运行，操作。【发送】得到想要返回数据，【保存】到测试集合中。如下：点击用例名称下方接口
mongodb 管理工具_YAPI:从0搭建API文档管理工具
weixin_39743622的博客
12-02 331
背景最近在找一款API文档管理工具，之前有用过Swagger、API Manager、Confluence，现在用的还是Confluence。我个人一直不喜欢用Swagger，感觉“代码即文档”，让代码里的文档无处不在，已经对代码造成了一定的入侵了。API Manager就是一个纯API文档管理的工具了。Confluence是万能的，也是最简单的，支持各种插件在线安装，可以有各种布局，支持MD文档...
java代码导出yapi接口文档
最新发布
sibin_my的博客
04-22 568
以上代码仅支持在yapi中导出格式为json的文件转换成word接口文档，如果要支持其他格式需要自行扩展哦。以上就是本次分享的全部内容，如有不足的地方欢迎各位大佬补充~~1、在yapi中导出所有的接口文档，格式为选择json。
接口文档规范总结学习
yw00yw的博客
04-10 463
接口规范（RESTful API规范： ） URL: 不含大写，uri地址里不允许出现大写字母，如果是两个单词拼接，用/分开 资源集合 在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。 例如： https...
yapi 接口文档_Yapi部署笔记
weixin_39841709的博客
12-12 201
官网地址：https://hellosean1025.github.io/yapi/index.htmlGithub: https://github.com/YMFE/yapi对比过其他的几款接口管理工具，阿里的Rap2，量级过大，依赖的数据库太多，因此没有采用，而Swagger Editor+Swagger UI的组合比较硬核，所有的接口规范都需要用yaml来编写，修改起来也并不容易，因此只能算...
Yapi接口工具使用教程
一如既往的准备文章
03-29 942
*** 生成Api接口名称 Interface和ChangeCase数据类型参见node_modules\yapi-to-typescript\lib\esm\index.d.ts定义* @returns 请求响应接口名称--pascal命名*/// 取解析路径dir最尾部的路径作为前缀路径// 拼接前缀路径+文件名称},prodEnvName: '图库',},// 文件夹名称取api-url路径末尾2个},
根据vo生成yapi文档：YapiFileGenerattor.zip
12-29
总结来说，"根据vo生成yapi文档：YapiFileGenerattor.zip"是一个实用的工具，它利用Java反射技术和Yapi的JSON导入功能，从VO类中自动生成接口文档，减少了手动编写文档的繁琐工作。这个工具对于大型项目尤其有价值，...
接口自动化使用工具-YAPI的使用文档
10-12
**接口自动化使用工具-YAPI的使用文档** YAPI是一款高效的接口管理工具，它支持接口的创建、测试和管理，尤其适合进行接口自动化测试。本文档将详细介绍如何利用YAPI进行接口自动化测试，包括创建测试集合、导入...
YapiIdeaUploadPlugin:yapi idea 上传插件,快速生成文档
04-30
减少yapi 录入时间，通过工具反向规范代码注释，和代码整洁 下载地址 1: 2:idea 插件库 更新速度 github>idea 插件库 支持语言 java,spring 单个&批量 单个上传选中方法名称 批量上传选中类名 支持接口 目前 dubbo...
yapi-enus 语言包:将yapi导出文档、网页等翻译成英文
01-03
其次，对于"网页公共部分"的国际化处理，意味着除了接口相关的文档之外，Yapi的用户界面元素、提示信息、帮助文档等也会被翻译成英文。这样，无论是浏览Yapi的菜单、设置还是操作指南，英文用户都将得到一致且准确的...
yapi二次开发的详细手册
04-08
yapi二次开发的详细手册主要包含四部分， 1本地yapi的部署，2服务器CentOS系统安装部署Yapi，3接口分类层级的修改，4新模块的增加 用了我一个月的时间梳理，也是不容易，大家如果做yapi的二次开发，可以看看。
苍穹外卖-YApi的使用，Swagger使用，详细文档整理yapi，Swagger等笔记...
chenyu_Yang的博客
02-02 617
参考文献：https://gitee.com/xyangge/yapi.git。进入管理端接口--数据管理--json。进入用户端接口--数据管理--json。
Yapi的使用原则
拱卒的博客
07-23 739
环境配置 ​ 官网链接：YApi-教程 (hellosean1025.github.io) ​ idea yapi 插件： ​ yapi 项目安装和部署：内网部署 (hellosean1025.github.io) 方法编写规范 /** * test 方法 * @param ${tags} * @return ${return_type} * @author yantingrui * @time 2021/7/23 15:02 *
docker-compose 之 yapi 在线接口文档
小单的博客专栏
05-04 1440
yapi 可视化在线接口文档 安装mongo 自行安装，或者使用你现有的，此处（略） PS：本人不喜欢把mongo耦合到docker中，重装docker什么的还得备份。 下载镜像 docker pull xzxiaoshan/yapi 创建配置文件 创建配置文件 config.js 内容为： { "port": "3000", "adminAccount": "admin@admin.c...
后端接口判断字段必填_打通前后端及QA的、可视化的接口管理平台
weixin_39611722的博客
12-06 388
平台介绍YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。特性基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍扁平化权限设计，即保证了大型企业级项目...
服务器消息API,yapi开放 api
weixin_30898967的博客
08-11 657
yapi开放 api开放接口api获取项目基本信息基本信息Path： /api/project/getMethod： GET接口描述：请求参数Query参数名称是否必须示例备注token是项目token新增接口分类基本信息Path： /api/interface/add_catMethod： POST接口描述：请求参数Headers参数名称参数值是否必须示例备注Content-Typeapplic...
YApi-高效、易用、功能强大的可视化接口管理平台——（二）YApi 分组权限
赵士杰——成功并非一蹴而就，而是在持之以恒的努力中逐渐实现。
07-07 944
YApi-高效、易用、功能强大的可视化接口管理平台——（二）YApi 分组权限
swagger接口文档同步yapi定义标准
qq_40224163的博客
01-12 913
ApiModel 用于swagger标记实体类属性类型默认值描述valueString类名类的备用名称String“”类的详细描述parentClass[]{}继承该类的子类型数组referenceString“”指定对应类型定义的引用，覆盖指定的任何其他元数据。
接口管理工具YApi怎么用？颜值高、易管理、超好用
霍格沃兹测试学院的博客
08-01 1004
众多接口管理工具如雨后春笋搬冒出。让人欣慰的是，有许多优秀作品来自国内，包含YApi和rap。看着中文的官网，熟悉的汉语，不禁让人暗爽。当然这也就带来另一个弊端，因为使用基数少，所以参考...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值