Skip navigation links
A C D E F G I M O P R S U V W 

A

applyRemoteUrl(Git) - Method in class com.magicapi.gitsync.GitRepoHelper
若配置了 remote-url(顶层优先,兼容 credential.remote-url 旧配置)且与当前 origin 不一致, 自动改写远程地址,使开发者无需手工修改本地克隆仓库

C

com.magicapi.gitsync - package com.magicapi.gitsync
 
commit(String, String) - Method in class com.magicapi.gitsync.MagicGitSyncService
提交本地全部变更并推送(编辑器"提交"按钮调用), 提交人与推送凭证均按编辑器登录用户名匹配个人凭证
commitAndPush(String, String) - Method in class com.magicapi.gitsync.GitRepoHelper
提交本地全部变更并推送
Credential() - Constructor for class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
credentialProvider(String) - Method in class com.magicapi.gitsync.GitRepoHelper
按编辑器登录用户名构建拉取/推送凭证,查找顺序: 数据库表 → yml credentials 列表 → credential 单人配置 → 全局账号
currentEditorUsername() - Method in class com.magicapi.gitsync.GitRepoHelper
从当前请求上下文中解析编辑器登录用户名(通过 Magic-Token 请求头),解析不到返回 null

D

Db() - Constructor for class com.magicapi.gitsync.MagicGitSyncProperties.Db
 
delete() - Method in class com.magicapi.gitsync.GitSyncResource
 
dirs() - Method in class com.magicapi.gitsync.GitSyncResource
 
doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class com.magicapi.gitsync.MagicConfigJsNoCacheFilter
 

E

ensureRepo() - Method in class com.magicapi.gitsync.GitRepoHelper
确保本地仓库存在:已克隆则直接返回,未克隆则按官方默认目录克隆

F

files(String) - Method in class com.magicapi.gitsync.GitSyncResource
 

G

getCredential() - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 
getCredentials() - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 
getDb() - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 
getDirectory(String) - Method in class com.magicapi.gitsync.GitSyncResource
 
getPassphrase() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
getPassword() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
getPassword() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.UserCredential
 
getPrivateKey() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
getRemoteUrl() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
getRemoteUrl() - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 
getResource(String) - Method in class com.magicapi.gitsync.GitSyncResource
 
getTable() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Db
 
getTokenColumn() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Db
 
getType() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
getUser() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.UserCredential
 
getUserColumn() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Db
 
getUsername() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
getUsername() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.UserCredential
 
getUsernameColumn() - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Db
 
gitCommit(String, String) - Method in class com.magicapi.gitsync.MagicGitSyncController
主动提交:将本地全部变更按提交说明提交并推送, 提交人与推送凭证为当前登录编辑器用户对应的个人凭证
GitRepoHelper - Class in com.magicapi.gitsync
Git 仓库操作与凭证解析助手 封装本地克隆目录定位、origin 地址校准、拉取、提交推送等仓库操作, 以及按编辑器登录用户名解析个人凭证: 数据库表(db.table)→ yml 列表(credentials)→ 单人配置(credential) → magic-api.resource.git 全局账号。
GitRepoHelper(MagicGitProperties, MagicAPIProperties, MagicGitSyncProperties, ObjectProvider<DataSource>, AuthorizationInterceptor) - Constructor for class com.magicapi.gitsync.GitRepoHelper
 
gitSync(String) - Method in class com.magicapi.gitsync.MagicGitSyncController
路径位于 magic-api.web(/magic/web)之外,不会进入编辑器自身的请求映射, 编辑器页面内以相对路径 ..
GitSyncResource - Class in com.magicapi.gitsync
增强版 Git 存储资源,顶替官方 magic-api-plugin-git 的 GitResource (官方 magicGitResource Bean 带 @ConditionalOnMissingBean,本插件先注册即自动替换)。
GitSyncResource(boolean, File, String, GitRepoHelper, MagicGitSyncProperties) - Constructor for class com.magicapi.gitsync.GitSyncResource
 
globalCredential() - Method in class com.magicapi.gitsync.GitRepoHelper
全局账号凭证(magic-api.resource.git)

I

isAutoCommit() - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 
isEnabled() - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 

M

MagicConfigJsNoCacheFilter - Class in com.magicapi.gitsync
禁止浏览器缓存编辑器自定义配置脚本(/magic/web/config-js)。
MagicConfigJsNoCacheFilter() - Constructor for class com.magicapi.gitsync.MagicConfigJsNoCacheFilter
 
magicConfigJsNoCacheFilter() - Method in class com.magicapi.gitsync.MagicGitSyncAutoConfiguration
禁止浏览器缓存编辑器配置脚本(config-js), 保证升级插件后刷新页面即可加载到最新的注入脚本
magicGitRepoHelper(MagicGitProperties, MagicAPIProperties, MagicGitSyncProperties, ObjectProvider<DataSource>, AuthorizationInterceptor) - Method in class com.magicapi.gitsync.MagicGitSyncAutoConfiguration
 
magicGitResource(GitRepoHelper, MagicGitSyncProperties) - Method in class com.magicapi.gitsync.MagicGitSyncAutoConfiguration
增强版 Git 存储资源,顶替官方 GitResource(官方 Bean 带 @ConditionalOnMissingBean)
MagicGitSyncAutoConfiguration - Class in com.magicapi.gitsync
MagicAPI Git 手动同步插件自动配置 接入方式:项目引入本 starter,且 magic-api 已启用 git 存储 (magic-api.resource.type=git)即自动生效,无需任何额外配置。
MagicGitSyncAutoConfiguration() - Constructor for class com.magicapi.gitsync.MagicGitSyncAutoConfiguration
 
magicGitSyncController(MagicGitSyncService, AuthorizationInterceptor) - Method in class com.magicapi.gitsync.MagicGitSyncAutoConfiguration
 
MagicGitSyncController - Class in com.magicapi.gitsync
MagicAPI Git 手动同步/提交接口 供编辑器右上角的"拉取"与"提交"按钮调用: 拉取:立即执行 git pull 并刷新内存接口 提交:将本地变更按填写的提交说明提交并推送 鉴权复用编辑器登录态:请求携带编辑器统一的 Magic-Token 请求头, 与内置 /reload 走同一套校验,无需额外配置秘钥;未登录时按钮不会渲染,接口也拒绝访问。
MagicGitSyncController(MagicGitSyncService, AuthorizationInterceptor) - Constructor for class com.magicapi.gitsync.MagicGitSyncController
 
MagicGitSyncProperties - Class in com.magicapi.gitsync
MagicAPI Git 同步插件配置 解决 magic-api 的 git 存储一个项目只能配置一套全局账号(magic-api.resource.git)的问题: 多个开发者协作时,按编辑器登录用户名匹配各自的个人凭证(HTTPS 账号/私人令牌)。
MagicGitSyncProperties() - Constructor for class com.magicapi.gitsync.MagicGitSyncProperties
 
MagicGitSyncProperties.Credential - Class in com.magicapi.gitsync
个人凭证配置
MagicGitSyncProperties.CredentialType - Enum in com.magicapi.gitsync
凭证类型
MagicGitSyncProperties.Db - Class in com.magicapi.gitsync
数据库凭证表配置:配置表名即启用,按编辑器用户名实时查询个人凭证
MagicGitSyncProperties.UserCredential - Class in com.magicapi.gitsync
多开发者凭证条目(yml 方式),以编辑器登录用户名为匹配键
magicGitSyncService(GitRepoHelper, MagicResourceService) - Method in class com.magicapi.gitsync.MagicGitSyncAutoConfiguration
 
MagicGitSyncService - Class in com.magicapi.gitsync
MagicAPI Git 同步服务 magic-api 的 git 插件默认只在应用启动时拉取远程仓库,运行期间推送到远程的代码 不会自动生效。
MagicGitSyncService(GitRepoHelper, MagicResourceService) - Constructor for class com.magicapi.gitsync.MagicGitSyncService
 
mkdir() - Method in class com.magicapi.gitsync.GitSyncResource
 

O

of(boolean, GitRepoHelper, MagicGitSyncProperties) - Static method in class com.magicapi.gitsync.GitSyncResource
构建工作区资源:确保本地仓库已克隆,并在启动时拉取一次远程最新代码

P

parent() - Method in class com.magicapi.gitsync.GitSyncResource
 
pull(String) - Method in class com.magicapi.gitsync.GitRepoHelper
执行一次 git pull

R

renameTo(Resource) - Method in class com.magicapi.gitsync.GitSyncResource
 
resolveCredential(String) - Method in class com.magicapi.gitsync.GitRepoHelper
解析当前请求对应的个人凭证(数据库表 → yml 列表),未命中返回 null(由调用方回退)
resolveRepoDir() - Method in class com.magicapi.gitsync.GitRepoHelper
定位本地克隆目录。
resources() - Method in class com.magicapi.gitsync.GitSyncResource
 

S

setAutoCommit(boolean) - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 
setCredential(MagicGitSyncProperties.Credential) - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 
setCredentials(List<MagicGitSyncProperties.UserCredential>) - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 
setDb(MagicGitSyncProperties.Db) - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 
setEnabled(boolean) - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 
setPassphrase(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
setPassword(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
setPassword(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.UserCredential
 
setPrivateKey(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
setRemoteUrl(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
setRemoteUrl(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties
 
setTable(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Db
 
setTokenColumn(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Db
 
setType(MagicGitSyncProperties.CredentialType) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
setUser(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.UserCredential
 
setUserColumn(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Db
 
setUsername(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Credential
 
setUsername(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.UserCredential
 
setUsernameColumn(String) - Method in class com.magicapi.gitsync.MagicGitSyncProperties.Db
 
sync() - Method in class com.magicapi.gitsync.MagicGitSyncService
执行一次 git pull,若有新提交则刷新内存中的接口(不区分操作人)
sync(String) - Method in class com.magicapi.gitsync.MagicGitSyncService
执行一次 git pull,按编辑器登录用户名匹配个人凭证;若有新提交则刷新内存中的接口

U

UserCredential() - Constructor for class com.magicapi.gitsync.MagicGitSyncProperties.UserCredential
 
UserCredential(String, String, String) - Constructor for class com.magicapi.gitsync.MagicGitSyncProperties.UserCredential
 

V

valueOf(String) - Static method in enum com.magicapi.gitsync.MagicGitSyncProperties.CredentialType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.magicapi.gitsync.MagicGitSyncProperties.CredentialType
Returns an array containing the constants of this enum type, in the order they are declared.

W

write(byte[]) - Method in class com.magicapi.gitsync.GitSyncResource
 
write(String) - Method in class com.magicapi.gitsync.GitSyncResource
 
A C D E F G I M O P R S U V W 
Skip navigation links

Copyright © 2026. All rights reserved.