magic-api配置Git插件教程

一、配置gitee.com

1,生成rsa密钥,在你的电脑右键使用管理员身份运行(命令提示符),执行下面命令

ssh-keygen -t rsa -b 2048 -m PEM

在这里插入图片描述
一直按回车键,不需要输入内容

  1. 找到 你电脑中的~/.ssh/id_rsa.pub 文件大概位置在:C:\Users\LENOVO.ssh,其中LENOVO为windows用户名,内容如下:

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDEL

3,把文件里面的内容复制其内容到 gitee.com的 SSH 公钥配置中,点击确认
在这里插入图片描述

4,添加known_hosts,将输出内容配置到known_hosts中,先执行下面命令

ssh-keyscan -t rsa gitee.com

![在这里插入图片描述](https://i-blog.csdnimg.cn/direct/d05152b63c3a47d297060c029dc578c8.png#pic_center在这里插入图片描述

5,在路径:C:\Users\LENOVO.ssh ,如果没有known_hosts文件就创建一个,内容如下(即步骤4生成的内容):

gitee.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDMzG3r

上面是省略版,只要在id_rsa.pub内容前面添加gitee.com复制进来即可

6,配置config
在路径:C:\Users\LENOVO.ssh ,如果没有config文件就创建一个,内容如下:

Host gitee.com
    HostName gitee.com
    User git
    IdentityFile C:\Users\LENOVO\.ssh\id_rsa
    IdentitiesOnly yes

需要改动的地方:gitee.com和C:\Users\LENOVO.ssh\id_rsa这两个位置

在这里插入图片描述

6,配置 magic-api,注意需要清空location配置的文件夹的内容

application.yml文件添加配置:

magic-api:
  resource:
    type: git
    git:
      url: git@gitlab.com:zhiyi98/spring-magic-api.git
      branch: main
      privateKey: C:\Users\LENOVO\.ssh\id_rsa
    # 本地存放路径
    location: D:/magic-api

pom.xml文件添加配置:

      <dependency>
        <groupId>org.ssssssss</groupId>
        <artifactId>magic-api-plugin-git</artifactId>
        <version>2.2.1</version>
      </dependency>
      <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
      </dependency>

7,启动magic-api项目,浏览器输入:http://192.168.110.23:9999/magic/web/index.html
在这里插入图片描述
随便修改一下接口内容,即可自动同步到仓库
在这里插入图片描述

二、配置gitlab.com

1,生成rsa密钥,在你的电脑右键使用管理员身份运行(命令提示符),执行下面命令

ssh-keygen -t rsa -b 2048 -m PEM

在这里插入图片描述
一直按回车键,不需要输入内容

  1. 找到 你电脑中的~/.ssh/id_rsa.pub 文件大概位置在:C:\Users\LENOVO.ssh,其中LENOVO为windows用户名,内容如下:

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDEL

3,把文件里面的内容复制其内容到 gitlab.com的 SSH 公钥配置中,点击确认
在这里插入图片描述

4,添加known_hosts,将输出内容配置到known_hosts中,先执行下面命令

ssh-keyscan -t rsa gitlab.com

在这里插入图片描述
注意:gitlab.com是你仓库的域名,如果你自己的私有仓库,请输入你的仓库地址

5,在路径:C:\Users\LENOVO.ssh ,如果没有known_hosts文件就创建一个,内容如下(即步骤4生成的内容):

gitlab.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDMzG3r

上面是省略版,只要在id_rsa.pub内容前面添加gitee.com复制进来即可

6,配置config
在路径:C:\Users\LENOVO.ssh ,如果没有config文件就创建一个,内容如下:

Host gitlab.com
    HostName gitlab.com
    User git
    IdentityFile C:\Users\LENOVO\.ssh\id_rsa
    IdentitiesOnly yes

需要改动的地方:gitlab.com和C:\Users\LENOVO.ssh\id_rsa这两个位置
在这里插入图片描述

6,配置 magic-api,注意需要清空location配置的文件夹的内容

application.yml文件添加配置:

magic-api:
  resource:
    type: git
    git:
      url: git@gitlab.com:zhiyi98/spring-magic-api.git
      branch: main
      privateKey: C:\Users\LENOVO\.ssh\id_rsa
    # 本地存放路径
    location: D:/magic-api

pom.xml文件添加配置:

      <dependency>
        <groupId>org.ssssssss</groupId>
        <artifactId>magic-api-plugin-git</artifactId>
        <version>2.2.1</version>
      </dependency>
      <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
      </dependency>

7,启动magic-api项目,浏览器输入:http://192.168.110.23:9999/magic/web/index.html,即可出现下面页面
在这里插入图片描述
随便修改一下接口内容,即可自动同步到仓库
在这里插入图片描述

<think>好的,我现在需要处理用户关于Magic-API的查询。用户希望了解Magic-API的文档和使用教程,而提供的引用内容中提到了整合Git插件、环境配置以及项目搭建和导入文件的相关信息。首先,我应该整理这些引用内容中的关键点,并按照用户的要求结构化回答。 首先,引用[2]提到了官方文档的链接,这是必须放在最前面的,方便用户直接访问。然后,用户可能需要的入门教程,引用[2]和[3]都涉及到环境配置和项目搭建,需要分步骤说明。接下来,关于Git插件的整合,引用[1]详细说明了生成RSA密钥的过程,这部分需要详细展开,因为用户可能遇到PG数据库的兼容问题,而Git备份是一个解决方案。此外,用户可能还会遇到常见问题,比如导入zip文件,引用[3]提到导入按钮的位置需要强调。 接下来,生成相关问题时要考虑用户可能的后续需求,比如配置问题、数据备份、接口调试和安全性等。这些问题需要覆盖Magic-API的不同使用场景和潜在难点,帮助用户全面了解。 需要确保回答符合系统级指令,特别是使用正确的中文和LaTeX格式,但看起来当前内容中不需要数学公式,所以可能不需要处理这部分。另外,引用标识要自然地添加在相关段落末尾,检查每个引用是否准确对应。 最后,整体结构要清晰,分点说明,步骤详细,确保用户能够一步步跟随操作。同时,语言要简洁明了,避免技术术语过多,方便不同层次的用户理解。检查是否有遗漏的引用或信息,确保所有引用的内容都被合理利用。确认所有链接和命令正确无误,特别是SSH密钥生成命令和官方文档链接。完成这些后,回答应该能满足用户的需求,并引导他们进一步探索Magic-API的使用。</think>### Magic-API 使用指南 Magic-API 是一个基于Java的接口快速开发框架,支持通过可视化配置生成API。以下是其核心使用文档和教程整理: #### 1. 官方文档与基础配置 - **官方文档**:Magic-API 的完整文档可访问 [https://www.ssssssss.org/magic-api](https://www.ssssssss.org/magic-api),包含环境配置API编写规范等基础内容[^2]。 - **环境搭建**(SpringBoot集成): ```xml <!-- pom.xml 添加依赖 --> <dependency> <groupId>org.ssssssss</groupId> <artifactId>magic-api-spring-boot-starter</artifactId> <version>2.1.0</version> </dependency> ``` 配置 `application.yml` 文件启用Magic-API控制台。 #### 2. 项目文件导入 - **导入ZIP文件**:在Magic-API控制台界面中,通过右上角的 **「导入」** 按钮上传ZIP格式的接口文件包[^3]。 - **文件结构要求**:ZIP包需包含完整的接口定义文件(如 `.json` 或 `.dsl` 文件)。 #### 3. Git插件整合(解决PG兼容问题) - **生成RSA密钥**: ```bash ssh-keygen -t rsa -b 2048 -m PEM # 生成密钥对用于Git仓库鉴权[^1] ``` - **配置Git备份**: 在Magic-API管理界面中配置Git仓库地址、分支及密钥路径,实现接口版本控制。 #### 4. 常见问题 - **历史记录查看**:默认PG数据库可能无法显示接口历史,建议优先使用Git备份功能。 - **接口调试**:通过控制台的 **「在线调试」** 模块可直接测试接口,支持参数动态注入。
评论 2
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值