Repository Files Organization

When you access an API repository, all files are organized into four categories. You can easily switch between these groups using the tabs in the upper right corner:

• API Documents
• Mock Scripts
• Test Cases
• All Files

Since the API repository is a Git repository, all files are under version control. The categorization into different tabs is simply to facilitate easier management. You can always navigate to the All Files tab to view and manage all files without any filtering.

API Documents

Files with the following characteristics are considered API document-related:

• Extensions: .json, .yaml, .md, or .mdx
• Not located in the /apigit-mock or /apigit-test folders

These files fall into two main categories:

• API Specification files must have .json or .yaml extensions
• Documentation files must have .md or .mdx extensions

In the API Documents tab, both file types are filtered and displayed in the left sidebar. You can use the visual editor or viewer to manage these files. Later, you can publish these files to build API specification and Markdown-based documentation sites.

Mock Scripts

Mock server-related files must follow these requirements:

• Located in the /apigit-mock folder
• Have .js extension

These files define mock routes and their handling logic, and are used to build Express.js-powered mock servers. In the Mock Scripts tab, these files are filtered and displayed in the left sidebar, where you can use the visual editor to manage your mock scripts.

Test Cases

API testing-related files must follow these requirements:

• Located in the /apigit-test folder
• No extension limitations, though JSON is recommended

These files are used to build API test cases and their handling logic. In the Test Cases tab, these files are filtered and displayed in the left sidebar, where you can use the visual editor or viewer to build and manage your test cases.