YApi自动生成接口文档

简介: YApi 是高效、易用、功能强大的API管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。

YApi

YApi是什么

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

YApi特性

它都有哪些特性呢?如下

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

YApi界面

使用

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

Docker 安装 YApi

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

安装 Nodejs

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

安装 MongoDB

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

npm 安装 YApi

在终端里运行

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

部署 Yapi

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

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

本地运行 YApi

进到 Yapi-cli目录,运行

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

跨域插件

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

导出导入

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

知识扩展:了解更多关于 YApi 的使用技巧!

相关文章
|
3月前
|
安全 API 开发工具
Gin 实现自动生成接口文档
Gin 实现自动生成接口文档
58 0
|
5月前
|
API 开发工具 git
ShowDoc自动生成api接口文档
ShowDoc自动生成api接口文档
144 0
|
5月前
|
JSON 数据安全/隐私保护 数据格式
SPA项目接口文档
SPA项目接口文档
21 0
|
JavaScript API
工具 | 自动生成api接口
这是一个将swagger接口文档自动生成TypeScript的api接口以及interface定义。
171 0
|
JSON 前端开发 JavaScript
Apifox,你的API接口文档卷成这样了吗?
使用过Apifox我相信都会被这个软件的细节之处,API接口文档功能强大之处给留下深刻的印象!一个软件工具的使命肯定是要为了使用者的便捷着想,处处的简化使用者的操作让工作更效率,这种才是一种好的工具的表现。
329 0
Apifox,你的API接口文档卷成这样了吗?
|
安全 数据可视化 Java
Swagger 自动生成 Api 文档:简化接口文档编写
自动生成 API 文档的好处不言而喻,它可以提供给你的团队或者外部协作者,方便 API 使用者准确地调用到你的 API。为了降低手动编写文档带来的错误,很多 API 开发者会偏向于寻找一些好的方法来自动生成 API 文档。
Swagger 自动生成 Api 文档:简化接口文档编写
|
算法 安全 jenkins
Apifox:API 接口自动化测试完全指南
如果要正常访问该接口的数据,需要在 header 中提供 AdminToken: token 头,这是一个常见的需要 JWT 登录认证接口。 很自然的我们想到,如果自动请求登录接口获取 token 值,然后在每次请求前自动带上这个 AdminToken 头不就行了吗,没错就是这样简单,伪代码如下:
Apifox:API 接口自动化测试完全指南
|
前端开发 搜索推荐 Java
聊聊接口文档的事儿
聊聊接口文档的事儿
227 0
|
Java API Maven
接口文档:第二章:使用Swagger接口的文档在线自动生成
接口文档:第二章:使用Swagger接口的文档在线自动生成
225 0
接口文档:第二章:使用Swagger接口的文档在线自动生成
|
前端开发 Java 程序员
接口文档生成神器-Swagger3
如果你是后端`java`开发程序员,你应该遇到过这样的场景,你的接口写完了,但是没有写接口文档,前端的小姐姐在焦急等待你的文档,那么你可能给小姐姐留下了一个不好的印象,那么有没有一款自动生成接口文档的工具呢? 答案是有,今天它来了。 `swagger`旨在帮助开发者摆脱写文档的烦恼,通过几个简单的注解,就可以生成很全面的接口文档。 本文旨在快速上手使用`swagger`生成接口文档,不得不说`swagger3`真香!!!