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 的使用技巧!

相关文章
|
8月前
|
JSON Dubbo 测试技术
逐步教你如何在Postman中导入Swagger API
在现代软件开发中,Swagger 和 Postman 作为 API 设计、开发和测试的利器,都被广泛应用。可以将 Swagger 定义的 API 导入到 Postman 中,充分利用 Postman 强大的测试特性对接口进行深入测试。
|
物联网 开发工具 Android开发
UniApp调用SDK原生接口
UniApp调用SDK原生接口
1220 0
UniApp调用SDK原生接口
|
8月前
|
人工智能 测试技术 API
Eolink创建临时服务mock接口数据——无限制那种非常带劲
Eolink创建临时服务mock接口数据——无限制那种非常带劲
66 1
|
8月前
|
API
uniapp上传文件api如何使用
uniapp上传文件api如何使用
499 3
|
5月前
|
安全 API 开发工具
Gin 实现自动生成接口文档
Gin 实现自动生成接口文档
81 0
|
7月前
|
数据挖掘 API 开发者
​Email API有哪些,最好的3个API接口有哪些
Email API如SendGrid、Mailgun和AOKSend是企业自动化邮件通信的关键工具。它们提供邮件发送、接收和管理功能,提升效率,优化客户体验。SendGrid以其高可靠性、强大分析和易于集成备受青睐;Mailgun以灵活性和高发送率著称;而AOKSend则以其高效、详细分析和易用性脱颖而出。通过使用这些API,企业能实现定制化邮件服务,跟踪性能,提升邮件营销效果。
|
安全 API 开发工具
获取仓库列表接口可以通过SDK或者REST API两种方式调用
获取仓库列表接口可以通过SDK或者REST API两种方式调用
92 2
|
7月前
|
API Android开发 iOS开发
个人微信开发API协议接口
个人微信开发API协议接口
|
8月前
|
小程序 Java API
如何优雅的设计一个SDK
如何优雅的设计一个SDK
199 0
|
8月前
|
小程序 API
小程序获取支付api
小程序获取支付api
168 0