【国产化软件】接口开放平台: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令牌管理

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

修改密码

移动版、黑夜模式和其他

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

手机移动端访问效果

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

相关文章
|
8天前
|
存储 人工智能 弹性计算
阿里云弹性计算_加速计算专场精华概览 | 2024云栖大会回顾
2024年9月19-21日,2024云栖大会在杭州云栖小镇举行,阿里云智能集团资深技术专家、异构计算产品技术负责人王超等多位产品、技术专家,共同带来了题为《AI Infra的前沿技术与应用实践》的专场session。本次专场重点介绍了阿里云AI Infra 产品架构与技术能力,及用户如何使用阿里云灵骏产品进行AI大模型开发、训练和应用。围绕当下大模型训练和推理的技术难点,专家们分享了如何在阿里云上实现稳定、高效、经济的大模型训练,并通过多个客户案例展示了云上大模型训练的显著优势。
|
12天前
|
存储 人工智能 调度
阿里云吴结生:高性能计算持续创新,响应数据+AI时代的多元化负载需求
在数字化转型的大潮中,每家公司都在积极探索如何利用数据驱动业务增长,而AI技术的快速发展更是加速了这一进程。
|
3天前
|
并行计算 前端开发 物联网
全网首发!真·从0到1!万字长文带你入门Qwen2.5-Coder——介绍、体验、本地部署及简单微调
2024年11月12日,阿里云通义大模型团队正式开源通义千问代码模型全系列,包括6款Qwen2.5-Coder模型,每个规模包含Base和Instruct两个版本。其中32B尺寸的旗舰代码模型在多项基准评测中取得开源最佳成绩,成为全球最强开源代码模型,多项关键能力超越GPT-4o。Qwen2.5-Coder具备强大、多样和实用等优点,通过持续训练,结合源代码、文本代码混合数据及合成数据,显著提升了代码生成、推理和修复等核心任务的性能。此外,该模型还支持多种编程语言,并在人类偏好对齐方面表现出色。本文为周周的奇妙编程原创,阿里云社区首发,未经同意不得转载。
|
8天前
|
人工智能 运维 双11
2024阿里云双十一云资源购买指南(纯客观,无广)
2024年双十一,阿里云推出多项重磅优惠,特别针对新迁入云的企业和初创公司提供丰厚补贴。其中,36元一年的轻量应用服务器、1.95元/小时的16核60GB A10卡以及1元购域名等产品尤为值得关注。这些产品不仅价格亲民,还提供了丰富的功能和服务,非常适合个人开发者、学生及中小企业快速上手和部署应用。
|
19天前
|
自然语言处理 数据可视化 前端开发
从数据提取到管理:合合信息的智能文档处理全方位解析【合合信息智能文档处理百宝箱】
合合信息的智能文档处理“百宝箱”涵盖文档解析、向量化模型、测评工具等,解决了复杂文档解析、大模型问答幻觉、文档解析效果评估、知识库搭建、多语言文档翻译等问题。通过可视化解析工具 TextIn ParseX、向量化模型 acge-embedding 和文档解析测评工具 markdown_tester,百宝箱提升了文档处理的效率和精确度,适用于多种文档格式和语言环境,助力企业实现高效的信息管理和业务支持。
3940 3
从数据提取到管理:合合信息的智能文档处理全方位解析【合合信息智能文档处理百宝箱】
|
8天前
|
算法 安全 网络安全
阿里云SSL证书双11精选,WoSign SSL国产证书优惠
2024阿里云11.11金秋云创季活动火热进行中,活动月期间(2024年11月01日至11月30日)通过折扣、叠加优惠券等多种方式,阿里云WoSign SSL证书实现优惠价格新低,DV SSL证书220元/年起,助力中小企业轻松实现HTTPS加密,保障数据传输安全。
521 3
阿里云SSL证书双11精选,WoSign SSL国产证书优惠
|
15天前
|
安全 数据建模 网络安全
2024阿里云双11,WoSign SSL证书优惠券使用攻略
2024阿里云“11.11金秋云创季”活动主会场,阿里云用户通过完成个人或企业实名认证,可以领取不同额度的满减优惠券,叠加折扣优惠。用户购买WoSign SSL证书,如何叠加才能更加优惠呢?
991 3
|
7天前
|
数据采集 人工智能 API
Qwen2.5-Coder深夜开源炸场,Prompt编程的时代来了!
通义千问团队开源「强大」、「多样」、「实用」的 Qwen2.5-Coder 全系列,致力于持续推动 Open Code LLMs 的发展。
|
12天前
|
机器学习/深度学习 存储 人工智能
白话文讲解大模型| Attention is all you need
本文档旨在详细阐述当前主流的大模型技术架构如Transformer架构。我们将从技术概述、架构介绍到具体模型实现等多个角度进行讲解。通过本文档,我们期望为读者提供一个全面的理解,帮助大家掌握大模型的工作原理,增强与客户沟通的技术基础。本文档适合对大模型感兴趣的人员阅读。
444 18
白话文讲解大模型| Attention is all you need
|
13天前
|
存储 分布式计算 流计算
实时计算 Flash – 兼容 Flink 的新一代向量化流计算引擎
本文介绍了阿里云开源大数据团队在实时计算领域的最新成果——向量化流计算引擎Flash。文章主要内容包括:Apache Flink 成为业界流计算标准、Flash 核心技术解读、性能测试数据以及在阿里巴巴集团的落地效果。Flash 是一款完全兼容 Apache Flink 的新一代流计算引擎,通过向量化技术和 C++ 实现,大幅提升了性能和成本效益。
661 10
实时计算 Flash – 兼容 Flink 的新一代向量化流计算引擎