Skip to main content

API document sync

API document sync

Version required: 2022.2.7+

Introduction

Used to synchronize API documents to Github、 Gitee、 Gitlab, and generate online documents and share them with other partners.

apiSync

Attention

  • If there is no network in the intranet, please use self-host GitLab. GitLab only supports v4 and does not support other versions.
  • If the configured repo does not exist in the cloud, a private repo will be created by default.
  • The project access has been 404. The solution is to set the repo as public or pull the partner to the repo to become a member when sharing.
  • A project corresponds to synchronizing a repo. After determining a repo and synchronizing some documents, keep the repo the same because history cannot be synchronized.

Configuration

apiSyncSetting

Note: The naming policy determines the name of the file synchronized to the cloud. The file name comes from the Javadoc or Swagger method naming annotation. If JavaDoc is checked, please ensure that the naming of the Javadoc and Swagger method must be short. Otherwise, the file name in the cloud will be very long. In this case, consider checking the method name to synchronize.

Token

When checking the permissions, you must ensure that the minimum permissions are checked to support the API sync and that the token is within the valid time frame.

Github:must check 'repo'
Gitlab:must check 'api'
Gitee:must check 'projects'

githubToken

gitlabToken

giteeToken