User Guides

Configuring GitHub integration

Xapi enables the organization owner and organization admins to configure GitHub integration in a project.

To configure an integration:


    Create integration

    Note that the Choose Integration pop-up will be appeared.

    Choose integration platform and type

    a. On the Integration Type drop-down, click Git Integration.

    b. On the Integration Platform drop-down, click GitHub Sync.

  2. Click Select. Note that the Configure GitHub Integration pop-up appears.

    Configure github integration
  3. Under the CONNECT GITHUB tab, connect to your GitHub account.


    Note: Fields marked with * are mandatory.

FieldDescriptionSample Value
Integration Name*This uniquely identifies the integration.Production Service
Connect GitHub or Git Token*To connect to your GitHub account, you may either:
  • Click Connect GitHub. Note that this will connect to your logged-in GitHub account automatically.
  • Click Git Token. This is to enter your GitHub token manulally.
  • ℹ️
    To create a GitHub personal access token, see Managing your personal access tokens (opens in a new tab).
    Make sure to add the following permissions when creating the fine-grained personal access token:
  • Read and write access for Email addresses and Profile
  • Read only access for Metadata
  • Read and write access for Administration, Commit statuses, Contents, and Pull requests
  •   a. Click Next.

      b. Under Details, enter the configuration details as given below.


    Note: Fields marked with * are mandatory.

    Repo Owner*This lists down the repository owners of the connected GitHub account. You may select a repository owner from the list.
    Repository*This lists down the repositories of the connected GitHub account.
    Note: The repository must contain at least one file.
    Branch*This is to specify the synchronizing branch. You may either:
  • Specify an existing branch name
  • Create a new branch by specifying a branch name.
  • Generate API Code*This specifies the API specification that you wish to generate, indicating whether global references should be included or excluded. The available file types are as follows:
  • JSON Resolved
  • JSON Unresolved
  • YAML Resolved
  • YAML Unresolved
  • Output Folder PathThis specifies the folder in which your API specification will be generated in the chosen GitHub repository when pushing the API. It is relative to the root folder of your repository. If the specified folder does not exist, a new folder will be created based on the given path.
    Note: Your path will be seperated by '/'.
    Your output folder path gets created according to the project catalog path in Xapi.
    Example: output folder path/catalog/API name/API version
    Default IntegrationThis designates the integration as 'default'. If this is selected, when synchronizing to GitHub, the API will synchronize with the default integration.
    If you do not choose a default integration, the system will automatically set the first created integration as the default.

      c. Click Next.

      d. Under REVIEW, you may review the entered details.

    1. Click Integrate. Upon successfully configuring the GitHub integration, a success message appears.

    What’s Next?