如何使用YApi自动生成文档

本文介绍如何使用 YApi 轻松自动生成 API文档,包括步骤和实用技巧。帮你快速生成高质量的 API 文档,提高开发效率。

用 Apifox,节省研发团队的每一分钟

如何使用YApi自动生成文档

免费使用 Apifox

相关推荐

最新文章

API

一体化协作平台

API 设计

API 文档

API 调试

自动化测试

API Mock

API Hub

立即体验 Apifox
目录

背景

设想一下,有一天你写了几十个接口,当你觉得骄傲自豪,并且准备上线的时候, 你的领导突然要你测一下这几十个接口的性能,请问你该咋办?

还能咋办!当然是借助一下 API 工具了!

API 工具

现在国内比较火的工具有这些:

今天就着重讲讲 YApiApifox

YApi

YApi 是什么

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

YApi 特性

它都有哪些特性呢?如下

  • 接口支持可视化
  • 拥有Mock功能
  • 具备测试接口的能力
  • 支持导入一些格式的api文件
  • 可以本地部署

YApi 界面

YApi自动生成文档
Yapi 界面
YApi自动生成文档
Yapi 界面

使用

这里就拿 Docker + Nodejs 来举例吧~

Docker 安装 YApi

通过docker安装:https://github.com/Ryan-Miao/docker-yapi

安装 Nodejs

需要到 Nodejs 的官网,下载 stable 版本,也就是稳定版

YApi自动生成文档
安装 Nodejs

安装 MongoDB

到 MongoDB 的官网下载,安装的话一直下一步下一步就行了

YApi自动生成文档
安装 MongoDB

npm 安装 YApi

在终端里运行

npm i -g yapi-cli --registry

安装后会启动 yarpi server ,端口号是 9090

部署 Yapi

然后需要部署一下,这样才能在本地访问 Yapi 文档

YApi自动生成文档
部署 Yapi

点击 开始部署 后,会出现密码和用户名。可以记起来

本地运行 YApi

进到 Yapi-cli目录,运行

node  vendors/server/app.js

这个时候浏览器的 3000 端口会运行 YApi 文档

YApi自动生成文档
本地运行 YApi

跨域插件

如果想要在浏览器 YApi 访问到本地接口,需要安装 Yapi 提供的谷歌插件~

导出导入

YApi 也支持导入导出数据,便于项目跨平台迁移

YApi自动生成文档
导出导入

Apifox 进行接口管理

团队

点击 新建团队

Apifox 进行接口管理
新建团队

并填入 团队名

Apifox 进行接口管理
填入 团队名

即可成功创建团队啦~

项目

点击 新建项目

Apifox 进行接口管理
新建项目

并填入 项目名

Apifox 进行接口管理
填入 项目名

项目是很重要的维度。

分组

Apifox 进行接口管理
添加子目录
Apifox 进行接口管理
添加分组

新建 接口

Apifox 进行接口管理
新建接口

功能介绍

Apifox 的 API 管理功能包括:

  • 接口管理
  • Mock、高级 Mock
  • 环境管理
  • 接口自动化测试
  • 数据库连接
  • 导入导出

可视化管理接口

Apifox 进行接口管理
可视化管理接口

Mock功能、环境管理

Mock功能、环境管理
Mock 功能、环境管理

自动化测试功能

apifox Mock功能、环境管理
自动化测试功能

可视化数据库选择

apifox Mock功能、环境管理
可视化数据库选择

导入导出

Apifox 支持 数据导出

apifox Mock功能、环境管理
数据导出

同样支持 数据导入,多达 22 种数据格式的导入,包含 postman、swagger、har、JMeter等~

apifox Mock功能、环境管理
数据导入

生成在线文档

Apifox 还支持生成在线文档,方便分享给其他人阅读,在线文档支持:

  • 生成请求代码
  • 在线调试
apifox Mock功能、环境管理
新建分享
apifox 生成在线文档
设置条件
apifox 生成在线文档
打开链接
apifox 生成在线文档
生成在线文档

总结

YApi 这款工具用起来很方便

但是 Apifox 功能更加齐全,包含了 YApi 的所有功能,并且拥有更多海量的功能!

Apifox = Postman + Swagger + Mock + JMeter

可以说这两者已经不在一个层级了,Apifox 明显更高大上一些,点击免费使用