【国产化软件】接口开放平台:Java+Swagger+Vue3,适配移动端

简介: 本文档介绍了基于Java的开放平台技术栈及使用流程,涵盖从注册开发者账号、创建应用、申请令牌到调用API接口的全过程。平台提供丰富的接口管理和统计功能,支持开发者在线维护个人资料和接口令牌,同时兼容移动设备访问和黑夜模式。技术栈方面,后端采用Spring Boot 3 + MySQL + Redis + RabbitMQ + Nacos,前端则基于Vue3 + TypeScript 5.x + Element Plus + UnoCSS。访问开放平台的地址为:http://java.test.yesapi.cn/platform/。

技术栈

【后端】Java,基于Spring Boot 3 + MySQL + Redis + RabbitMQ + Nacos

【前端】基于vue3 + typescript5.x + element-plus@2.8.x + unocss@0.5.x

使用流程和访问

新手开发者的主要使用流程是:

  • 第一步、注册开发平台,并登录
  • 第二步、创建新应用,并等待管理后台审核通过
  • 第三步、根据应用的app_key和密钥,申请新的令牌
  • 第四步、使用令牌,调用API开放接口
  • 第五步、结合OpenAPI,开发自己的应用

访问开放平台(演示环境)

开放后台的地址是:
http://java.test.yesapi.cn/platform/

假设配置的域名是:http://java.test.yesapi.cn/

或者通过官网的导航菜单,点击【登录】/【注册】跳转进入开放平台。

注册和登录

注册开发者账号

进入开发者注册页面,按提示填写注册信息,然后提交。

登录开放平台

注册成功后,进入开放平台登录页面,输入登录账号和密码,然后登录。

开放平台首页

在开放平台tudm,可以查看到概况统计、我的应用、接口管理、开发者中心、接口流量统计图表和表格数据、已提交的工单等概要信息。

应用管理

创建我的应用

进入【应用管理】-【我的应用】-【创建新应用】,按要求填写相关信息,确认提交,然后等待管理员审核。

填写应用信息:

创建新应用后等待管理员审核并,查看已经成功申请的应用密钥:

除了密钥,你还可以查看自己应用的其他信息,包括但不限于:

  • 应用图标
  • 应用名称
  • 应用AppKey
  • 有效日期(为空时表示不限制)
  • 应用状态(正常使用/注销/禁用)
  • 审核状态(待审核/已通过/未通过)
  • 所属机构

应用审核通过后,可查看应用的接口权限。

接口管理

在管理员分配接口权限后,就可以调用需要的开放接口API。

应用接口权限

在 接口权限 页面,可以选择和切换自己的应用,搜索和查看 已获得的接口权限,或 未获得的接口权限,或全部接口。

对于需要付费才能调用的接口,可以在线立即购买。

账号接口申请

对于未获得权限的接口,如需使用,可以进行接口权限申请。成功申请后,等待管理后台审批。

调用OpenAPI开放接口

开发者在调用开放接口前,需要先注册开发者账号,创建新的应用并等待管理员审核通过,并且只能调用已分配权限的接口。

获取接口访问令牌

首先,开发者需要根据已申请的 app_key 和 app_secret 创建新的访问令牌。可以使用接口**
/official/auth/apply_token 申请访问令牌**。

通过在线接口文档,找到并选择【
/official/auth/apply_token】申请访问令牌。输入应用的app_key和密钥,获取令牌:

例如:

curl -X 'POST' \
  'http://java.api.yesapi.cn/api/official/auth/apply_token' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '{
  "app_key": "LRB9iLkJVSIIgTguGNmVP3vGX",
  "app_Secret": "EyC1ceQ87Md4cFPR8eJZ4Lod1CKJTxTuVHk4eChetpV5gLGQCgCfXODoj8yH",
  "uid": 0
}'

申请成功后,接口会返回access_token访问令牌,以及expire_at有效时间。例如:

{
  "code": 200,
  "message": "SUCCESS",
  "data": {
    "access_token": "OuOwEdzaZfKnhJij5vOvY9SAKvGFBTispj95ugIjXn6l1XF7VuBU3bQqsFAY1FYPDX+OxLUKM8kYu6o3HwZJWTFOhXu1WKK4P1/LFHT4/IaKLdnrOv7cFb6dgVqTiB0BW9K6uMCWthOiV98XZXhdhN6hcUGR55qLles5OUTECG0=",
    "expire_time": "2024-12-12 08:28:28",
    "expire_at": 1733992108935
  }
}

得到令牌access_token后,便可继续请求其他API接口。

请求具体的开放接口

接下来,就可以根据access_token访问令牌,访问其他的开放接口。

例如,调用 Hello World 接口,

curl请求报文是:

curl -X 'GET' \
  'http://java.api.yesapi.cn/api/demo/hello_world' \
  -H 'access-token: OuOwEdzaZfKnhJij5vOvY9SAKvGFBTispj95ugIjXn6l1XF7VuBU3bQqsFAY1FYPDX+OxLUKM8kYu6o3HwZJWTFOhXu1WKK4P1/LFHT4/IaKLdnrOv7cFb6dgVqTiB0BW9K6uMCWthOiV98XZXhdhN6hcUGR55qLles5OUTECG0=' \
  -H 'accept: */*'

得到的请求结果类似:

{"code":200,"message":"SUCCESS","data":"Hello World!"}

统计

统计模块,主要提供了每日接口统计,支持日期范围、AppKey、API接口的搜索,图形展示,数据表格;以及详细的接口请求日记。

每日接口统计

每日接口统计:

接口请求日记

接口请求日志:

开发者中心

开发者资料

查看和修改开发者资料。

Token令牌管理

可以在线维护、查看和管理自己的接口令牌。

修改密码

移动版、黑夜模式和其他

你可以切换到黑夜模式,也可以使用手机移动端访问,还可以自己配置菜单布局方式。

手机移动端访问效果

手机移动端访问效果如上。

相关文章
|
4天前
|
存储 监控 安全
单位网络监控软件:Java 技术驱动的高效网络监管体系构建
在数字化办公时代,构建基于Java技术的单位网络监控软件至关重要。该软件能精准监管单位网络活动,保障信息安全,提升工作效率。通过网络流量监测、访问控制及连接状态监控等模块,实现高效网络监管,确保网络稳定、安全、高效运行。
30 11
|
2月前
|
缓存 算法 Java
Java 实现的局域网管控软件的性能调优
局域网管控软件在企业网络管理中至关重要,但随着网络规模扩大和功能需求增加,其性能可能受影响。文章分析了数据处理效率低下、网络通信延迟和资源占用过高等性能瓶颈,并提出了使用缓存、优化算法、NIO库及合理管理线程池等调优措施,最终通过性能测试验证了优化效果,显著提升了软件性能。
41 1
|
1月前
|
监控 前端开发 Java
【技术开发】接口管理平台要用什么技术栈?推荐:Java+Vue3+Docker+MySQL
该文档介绍了基于Java后端和Vue3前端构建的管理系统的技术栈及功能模块,涵盖管理后台的访问、登录、首页概览、API接口管理、接口权限设置、接口监控、计费管理、账号管理、应用管理、数据库配置、站点配置及管理员个人设置等内容,并提供了访问地址及操作指南。
|
2月前
|
前端开发 Java API
Swagger接口文档 —— 手把手教学,全方位超详细小白能看懂,百分百能用Java版
本文提供了一份详细的Swagger接口文档生成工具的使用教程,包括了导入依赖、配置类设置、资源映射、拦截器配置、Swagger注解使用、生成接口文档、在线调试页面访问以及如何设置全局参数(如token),旨在帮助Java开发者快速上手Swagger。
628 0
Swagger接口文档 —— 手把手教学,全方位超详细小白能看懂,百分百能用Java版
|
5月前
|
JavaScript 前端开发 Java
Java入门软件及基础语法
**摘要:** - **IDEA:** IntelliJ IDEA,顶级Java开发环境,支持Java,JS,JQuery,Ajax调试. - **JDK:** Java开发包含编译器`javac`,JVM,辅助运行Java程序,核心含JRE,tools.jar,rt.jar. - **Git:** 分布式版本控制,管理源代码,支持回溯,协作,远程备份. - **基础语法:** - `if`: 控制流,单/多分支选择,可嵌套,省略单行大括号. - `switch`: 表达式匹配`case`值,执行对应代码,需`break`防穿透.
36 1
|
5月前
|
NoSQL Java Redis
软件开发常见流程之宝塔初始化安装环境配置,Lam前面不选,直接跳商城,在宝塔内点击软件商城,安Mysql5.7,安java项目管理器,安Ngnix最新版,安Redis
软件开发常见流程之宝塔初始化安装环境配置,Lam前面不选,直接跳商城,在宝塔内点击软件商城,安Mysql5.7,安java项目管理器,安Ngnix最新版,安Redis
|
5月前
|
SQL XML JavaScript
【若依Java】15分钟玩转若依二次开发,新手小白半小时实现前后端分离项目,springboot+vue3+Element Plus+vite实现Java项目和管理后台网站功能
摘要: 本文档详细介绍了如何使用若依框架快速搭建一个基于SpringBoot和Vue3的前后端分离的Java管理后台。教程涵盖了技术点、准备工作、启动项目、自动生成代码、数据库配置、菜单管理、代码下载和导入、自定义主题样式、代码生成、启动Vue3项目、修改代码、以及对代码进行自定义和扩展,例如单表和主子表的代码生成、树形表的实现、商品列表和分类列表的改造等。整个过程详细地指导了如何从下载项目到配置数据库,再到生成Java和Vue3代码,最后实现前后端的运行和功能定制。此外,还提供了关于软件安装、环境变量配置和代码自动生成的注意事项。
3892 3
|
6月前
|
Java
2016届蓝桥杯大赛软件类国赛Java大学B组 愤怒小鸟 数学模拟
2016届蓝桥杯大赛软件类国赛Java大学B组 愤怒小鸟 数学模拟
53 4
|
6月前
|
Java
2022蓝桥杯大赛软件类国赛Java大学B组 左移右移 空间换时间+双指针
2022蓝桥杯大赛软件类国赛Java大学B组 左移右移 空间换时间+双指针
48 3
|
6月前
|
Java 关系型数据库 开发者
Java编程设计原则:构建稳健、可维护的软件基石
Java编程设计原则:构建稳健、可维护的软件基石