Fast Request
快速上手
功能
最新变化
脚本
视频教程
🔥 团队协作
群聊
🎯 FAQ

成为赞助商
  • 简介
  • 安装
    • 让图标动起来
    • Project 级别域名配置
    • 项目级别全局参数支持
    • SearchEveryWhere
    • API 分组
    • 调试 API 发送请求
    • 下载文件
    • 终止 API 请求功能
    • 当前方法定位
    • 保存请求
    • 临时请求保存支持
    • Apifox 集成
    • Postman 集成
    • 重新生成请求
    • cURL 导入
    • CURL 拷贝
    • 一键拷贝 Url
    • API 文档同步
    • 历史请求预览
    • 管理配置
    • 全屏
    • 年度报告
    • 文档/快速联系
    • Html 预览
    • Swagger 默认值
    • API 自动生成注释
    • API 列表
    • API 导出到 Postman
    • APIs 导入导出
    • 批量导出 API 文档
    • API 导航树
    • API 一览表预览
    • Api 注释预览
    • 脚本
    • 函数
    • 快速添加 header
    • 自动域名
    • AI
    • Headers 分组
    • Headers批量编辑
    • 自定义工具栏
    • Json 语法检查
  • 脚本
  • Environment
  • 最新变化
  • 团队协作
  • 购买
  • 版本对比
  • 群聊
  • 视频教程
  • FAQ
  • EULA
  • 价格调整
  • 赞助列表
  • 活动
  • 友情链接
  • 历史变更
  • 功能

API 文档同步


API 文档同步

版本要求: 2022.2.7+

介绍

用于将 API 文档同步至 Github、 Gitee、 Gitlab, 生成在线文档,分享给其他的小伙伴看。

apiSync

注意点

  • 内网无网络情况下请用私有域名 gitlab,gitlab 只支持 v4 不支持其他版本,不行考虑升级
  • 如果配置后的仓库在云端不存在,则默认创建私有的仓库
  • 项目访问 404 了,解决办法是分享的时候需要将仓库设置为 public 或者将小伙伴拉至仓库成为某一个成员
  • 一个项目对应同步一个仓库,确定好一个仓库并且同步了一部分文档以后,不要再在后面切换修改仓库,历史记录无法同步

配置介绍

apiSyncSetting

注意点: 命名策略决定了同步至云端的文件名称,文件名称来自 Javadoc 或者 Swagger 方法命名注解,如果勾选使用 javadoc,请确保 Javadoc 和 Swagger 方法命名一定要简短, 否则云端的文件名会非常长,这种情况下考虑勾选方法名来同步。

Token

生成的 token 需要勾选对应的最小权限来支持 api 同步,同时需要确保 token 在有时间效期内

  • Gitee

必须勾选 projects

giteeToken

  • GitHub

必须勾选 repo

githubToken

  • Gitlab

必须勾选 api

gitlabToken

上次编辑于: 2025/5/9 01:23:16
上一页
一键拷贝 Url
下一页
历史请求预览
主题使用 vuepress-theme-hope
Copyright © 2021-present Kings