Yapi工具

来源:【https://www.yuque.com/testops/igzdgd/vin3i5
YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

一、安装

这里通过Docker来完成Yapi的安装。
如果过程出现意外安装错误希望从头开始,通过这个命令清空所有镜像(请在自己干净的docker体系上)

docker system prune -a -f

1、启动Docker

在Centos7中通过ifconfig获取ip,如果没有自动获取DHCP的IP可以使用命令dhclient更新。

yum install docker

通过客户端连接后,使用命令

service docker start

启动服务。
输入docker命令可以看到正常启动。
更新容器加速镜像

# vi /etc/docker/daemon.json
{
    "registry-mirrors": ["http://hub-mirror.c.163.com"]
}

2、安装Yapi用的MongoDB

通过Docker下载Mongo数据库镜像并启动,重命名mongo数据镜像为mongo-yapi

docker run -d --name mongo-yapi mongo

3、下载yapi的docke

拉取yapi官方镜像

docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

4、启动mongo的数据库及配置账号

连接mongo数据库并运行初始化脚本

docker run -it --rm \
  --link mongo-yapi:mongo \
  --entrypoint npm \
  --workdir /api/vendors \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  run install-server

5、启动yapi的Docker

启动yapi的镜像。

docker run -d \
  --name yapi \
  --link mongo-yapi:mongo \
  --workdir /api/vendors \
  -p 3000:3000 \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  server/app.js

访问服务器IP的3000端口。
在这里插入图片描述

使用管理员账号登录(admin@admin.com ymfe.org)

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring Boot和Yapi是两个不同的框架,Spring Boot是一个基于Java语言的开发框架,用于快速创建Web应用程序,而Yapi是一个接口管理工具,用于管理和维护API接口文档。 要在Spring Boot中整合Yapi,可以使用YapiAPI接口来将API接口文档上传到Yapi服务器中。以下是整合步骤: 1. 安装Yapi服务器并创建项目。可以参考Yapi官方文档进行安装和创建项目。 2. 在Spring Boot应用程序中添加Yapi相关依赖。可以使用以下Maven依赖: ```xml <dependency> <groupId>com.github.wujiuye</groupId> <artifactId>yapi-sync-maven-plugin</artifactId> <version>1.0.0</version> </dependency> ``` 3. 在Spring Boot应用程序中添加Yapi配置。可以在application.properties文件中添加以下配置: ```properties yapi.url=http://localhost:3000 # Yapi服务器地址 yapi.project.id=1 # Yapi项目ID yapi.token=abc123 # Yapi项目Token ``` 4. 在Spring Boot应用程序中添加Yapi上传插件。可以使用以下Maven插件: ```xml <plugin> <groupId>com.github.wujiuye</groupId> <artifactId>yapi-sync-maven-plugin</artifactId> <version>1.0.0</version> <executions> <execution> <id>upload-to-yapi</id> <phase>install</phase> <goals> <goal>upload</goal> </goals> </execution> </executions> </plugin> ``` 5. 在Spring Boot应用程序中添加API接口文档注释。可以使用以下注释格式: ```java /** * @api {请求方法} /接口路径 接口名称 * @apiDescription 接口描述 * @apiParam 参数名 参数类型 参数描述 * @apiSuccess 返回参数类型 返回参数描述 * @apiError 错误码 错误描述 */ ``` 6. 在Spring Boot应用程序中编写API接口代码。可以使用Spring MVC或Spring WebFlux等框架编写API接口代码。 7. 在Spring Boot应用程序中生成API接口文档。可以使用Swagger或Springfox等框架生成API接口文档。 8. 在Spring Boot应用程序中上传API接口文档到Yapi服务器。可以使用以下命令: ```bash mvn yapi-sync:upload ``` 9. 在Yapi服务器中查看API接口文档。可以登录Yapi服务器并查看项目中的API接口文档。 注意:在上传API接口文档到Yapi服务器之前,需要确保Yapi服务器已经启动并且配置信息正确。同时,需要确保API接口文档的注释信息正确无误。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值