开源一个 API 开放平台门户前端:本地 npm run dev 就能逛接口文档

开源一个 API 开放平台门户前端:本地 npm run dev 就能逛接口文档

适合:想自建 API 门户、或需要一套「接口目录 + 文档 + 在线调试」前端壳的同学。

背景

做开放平台时,前端往往要同时扛几件事:

  • 接口分类浏览(免费 / 会员 / 计次)
  • 文档页(路径、参数、错误码、调用示例)
  • 在线调试(粘贴 X-Api-Key 直接试调)
  • 用户控制台 UI(Token、调用日志等)

后端鉴权、计费、额度可以慢慢迭代,但门户体验最好尽早有一套可跑的前端。

于是把线上门户前端单独抽出来,做成开源演示仓库。

仓库与在线效果

技术栈:Vue 3 + Vite + Element Plus + Pinia + Axios。

首页

分类入口、搜索、接口卡片一览:

探索页

按分类与计费类型筛选全量接口:

接口文档页

请求地址、参数、说明与「在线调试」入口:

30 秒跑起来

bash 复制代码
git clone https://github.com/XuChen-Wang/sanyu-open-web-demo.git
cd sanyu-open-web-demo
npm install
npm run dev

默认开发端口 8081。/api 会代理到线上文档站,本地不必起 Java 后端也能浏览接口列表和文档页。

自定义代理:

bash 复制代码
cp .env.example .env.development
# 修改 VITE_PROXY_TARGET / VITE_PROXY_STRIP_API

能看什么

页面 作用
首页 Banner、搜索、分类入口
探索 全量接口卡片 + 分类 / 计费类型筛选
文档详情 请求地址、参数表、返回说明、curl / fetch 示例
在线调试 粘贴 Token 后试调开放接口
控制台 UI Token、日志等页面结构(登录能力依赖后端)

说明:本仓库只有前端。登录、额度、计费由后端提供;仓库内不内置任何真实 Key。

调试怎么接

开放接口鉴权头是 X-Api-Key。流程很简单:

  1. 在文档站注册 / 登录
  2. 控制台创建 Token
  3. 粘到文档页「在线调试」面板

本地调试和线上文档体验一致,方便对照字段。

为什么开源前端就够

很多同学其实不需要一上来就 fork 整套 Spring Boot 多模块。先把门户交互、文档结构、调试面板跑通,再决定后端怎么拆,成本更低。

若你关心的是「完整能力目录、额度说明、账号体系」,直接看在线文档站即可;本仓库负责把 UI 与调用路径讲清楚。

License

MIT。欢迎 Star、提 Issue,或直接改造成自己的 API 门户壳。


相关链接:

相关推荐
IT_陈寒14 分钟前
Vite性能优化完全指南
前端·人工智能·后端
燕落南枝16 分钟前
HTML 表单入门:表单容器、文本框与密码框属性详解
前端·microsoft·html
TYC929 分钟前
Mac创建Vue3+TypeScript或者React+TypeScript项目
前端·javascript·typescript
程序员小孔.31 分钟前
基于 SpringBoot + UniApp + Vue 的家政服务系统设计与实现
前端·数据库·spring boot·python·docker·微信小程序
Profile排查笔记37 分钟前
指纹浏览器 GitHub 项目怎么选?先看仓库交付的是工具、内核还是管理器
前端·人工智能·后端·自动化
风骏时光牛马41 分钟前
云原生驱动的分布式高可用架构设计与落地实践
前端
梦曦i1 小时前
uni-app x 专属 Pinia 库正式发布
前端·pinia·uni-app x
一次旅行2 小时前
DeepSeek‑V4.1‑Flash‑1017完整解读:模型升级+Search/Fetch搜索API开放,Agent开发者要注意哪些坑
前端·网络·人工智能
原则猫10 小时前
UDP 到底怎么实现可靠的
前端
Java后端的Ai之路10 小时前
14、ReactJS - 路由(Router)
前端·react.js·状态模式