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

相关文章
|
NoSQL Cloud Native 数据可视化
云原生之使用Docker部署YApi接口管理服务平台
云原生之使用Docker部署YApi接口管理服务平台
1021 0
云原生之使用Docker部署YApi接口管理服务平台
|
前端开发 Java 调度
springboot整合SSE技术开发经验总结及心得
springboot整合SSE技术开发经验总结及心得
2119 0
|
JavaScript
vue element plus Transfer 穿梭框
vue element plus Transfer 穿梭框
382 0
|
20天前
|
测试技术 API 开发工具
API文档该怎么写,开发效率能翻几倍?
API文档是提升开发效率与协作的关键因素,本文探讨了API文档的核心要素、常见类型及编写规范,并介绍了如何借助现代化工具如Apifox实现高效管理与维护,助力团队打造高质量的API文档体系。
|
5月前
|
人工智能 API
MCP协议的局限性
5年前,我把 AI 比喻为一种智能化的 API 网关,提出一种分治的思想,将一个大问题转换为若干可解的小问题,如今,这种思想正在 mcp 这种协议沿用。但目前来看,它的实现方式还是有点丑陋的,并且有一些问题。
|
9月前
|
Linux API C#
基于 .NET 开发的多功能流媒体管理控制平台
基于 .NET 开发的多功能流媒体管理控制平台
143 9
|
11月前
|
存储 缓存 数据安全/隐私保护
OCSP装订(OCSP Stapling)是什么?
问题2:OCSP装订是否会增加服务器的内存消耗? 答:虽然OCSP响应的预加载可能会稍微增加服务器的内存消耗,但这种增加通常较小。服务器只需为每个域名存储一份OCSP响应副本。现代操作系统和Web服务器通常具备缓存机制,可以有效减轻内存消耗。
210 1
|
12月前
|
物联网 5G UED
深入解析载波聚合及其对无线通信性能的提升
深入解析载波聚合及其对无线通信性能的提升
842 1
|
网络协议 安全 Shell
`nmap`是一个开源的网络扫描工具,用于发现网络上的设备和服务。Python的`python-nmap`库允许我们在Python脚本中直接使用`nmap`的功能。
`nmap`是一个开源的网络扫描工具,用于发现网络上的设备和服务。Python的`python-nmap`库允许我们在Python脚本中直接使用`nmap`的功能。
|
计算机视觉
Echarts饼图,自定义饼图图例的排列方式, formatter使用语法
Echarts饼图,自定义饼图图例的排列方式, formatter使用语法