magic-api magic-api
首页
  • 快速入门
  • 基础教程
  • 权限配置
  • 高级应用
  • 开发插件
  • 模块
  • 函数
  • 扩展
  • Gitee (opens new window)
  • Github (opens new window)
  • 演示 (opens new window)
  • SpringBoot配置
  • 编辑器配置
  • 2.x更新日志
  • 1.x更新日志
  • 0.x更新日志
常见问题
💖支持
交流群
首页
  • 快速入门
  • 基础教程
  • 权限配置
  • 高级应用
  • 开发插件
  • 模块
  • 函数
  • 扩展
  • Gitee (opens new window)
  • Github (opens new window)
  • 演示 (opens new window)
  • SpringBoot配置
  • 编辑器配置
  • 2.x更新日志
  • 1.x更新日志
  • 0.x更新日志
常见问题
💖支持
交流群
  • 快速入门

    • 简介
    • 快速开始
    • 请求参数获取
    • 增删改查
    • 单表crud接口
    • 分页
  • 基础教程

    • 界面简介
    • 脚本语法
    • 配置多数据源
    • 统一请求响应
    • 统一异常处理
    • 参数校验
    • 脚本调用Java
    • Java调用接口
    • 异步调用
    • 接口发布
      • Lambda
      • Linq
      • 从1.x迁移
    • 权限配置

      • UI鉴权登录
      • UI操作鉴权
      • 接口鉴权
    • 高级应用

      • 自定义拦截器
      • 自定义SQL拦截器
      • 自定义单表API拦截器
      • 自定义SQL缓存
      • 自定义模块
      • 自定义函数
      • 自定义类型扩展
      • 自定义接口存储
      • 自定义数据库方言
      • 自定义列名转换
      • 自定义脚本语言
    • 插件

      • 插件开发
      • 集群插件
      • 定时任务插件
      • Redis插件
      • Mongo插件
      • ElasticSearch插件
      • Swagger插件
      • Git插件
      • SpringDoc插件
      • nebula插件
    • 指南
    • 基础教程
    mxd
    2022-01-30
    目录

    接口发布

    # 导出&上传

    在本地环境中,写好接口后,可以通过导出,在到生产环境中通过上传的方式进行部署

    导出

    上传

    • 增量上传 此模式上传仅仅针对上传的资源中进行更新,不会对接口进行删除操作。
    • 全量上传 此模式以上传内容为基准,全量覆盖更新,如果没有必要不建议进行此操作。

    此方法对于除只读模式外的所有方式配置均有效。

    # 使用文件

    此方法适合配置文件中配置方式是如下形式的:

    magic-api:
      resource:
        type: file # 此项默认值是file,可省略
        location: /xx/xx/xx/magic-api # 配置文件存储路径
    

    此时需要把本地资源上传到该目录下,然后在到UI界面上点击整个页面右上角的刷新按钮。

    另外也可以通过上传、推送的方式进行部署

    # 使用Jar

    对于将接口信息存到jar内的,部署需要将写好的接口信息打包至jar内,重新部署即可

    magic-api:
      resource:
        location: classpath: magic-api # 接口信息存放在 src/main/resources/magic-api 下
    

    # 使用数据库

    需要将写好的接口信息,自行同步到数据库中,同步后,点击页面上右上角的刷新按钮即可

    另外也可以通过上传、推送的方式进行部署

    # 使用Redis

    需要将写好的接口信息,自行同步到Redis中,同步后,点击页面上右上角的刷新按钮即可

    另外也可以通过上传、推送的方式进行部署

    # 接口推送

    # 前置条件

    • 推送的目标开启了推送配置
    • 推送的目标不是只读模式
    • 从本地能连通至目标服务

    推送

    # 本地和远程使用同一个存储

    # 前置条件

    • 本地和远程使用一个数据库或Redis或同一个存储位置
    • 远程开启了UI界面

    # 更新方式

    由于magic-api启动之后,会将接口信息缓存至内存中,所以数据库发生改变后,对于应用是无感知的,需要重新读取,此时点击页面右上角的刷新按钮即可

    另外对于这种方式是不推荐的,因为本地修改后可能会影响到正式接口

    上次更新: 2025-05-03 23:57:14
    异步调用
    Lambda

    ← 异步调用 Lambda→

    Theme by Vdoing | Copyright © 2020-2025 ssssssss.org | MIT License
    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式
    ×