1. Project Overview

ApiChain is an API testing and documentation generation tool based on version iterations and project perspectives. Compared with external tools like Postman, ApiChain understands your workflow better.

2. Open Source License

Licensed under MIT

3. Screenshots

4. Feature Overview

An API testing and documentation generation tool based on version iterations and project perspectives.

APIChain offers the following features:

1. Generates API documentation for each iteration and consolidates iteration-related APIs by project. Iteration documentation can be shared in real time through links using your local intranet IP address, or exported in formats such as HTML and Markdown;

2. Environment variables are supported at three levels: global, project, and iteration;

3. Supports more types of random input parameters;

4. Supports testing and documentation generation for URL path parameters;

5. Can include response header and cookie information in API documentation;

6. Can chain together the input parameters and responses of multiple API calls to create reusable, repeatable unit test cases, including the use of cookie and header information returned by previous steps;

7. Iteration unit test cases can be merged into projects for project regression testing;

8. Operates entirely within the local intranet and does not require an internet connection;

9. Can consolidate links to requirements documents and UI design documents associated with an iteration, along with information about database changes, configuration center changes, and more, into the iteration's API documentation;

5. Tech Stack

ApiChain is an API testing and documentation generation tool based on version iterations and project perspectives. Compared with external tools like Postman, ApiChain understands your workflow better.

Compile from Source Code

Version Dependencies:

• nodejs：v20.12.2

• electron：26.2.4

npm install -g yarn
yarn config set ELECTRON_MIRROR https://registry.npmmirror.com/-/binary/electron/
yarn config set ELECTRON_BUILDER_BINARIES_MIRROR https://registry.npmmirror.com/-/binary/electron-builder-binaries/
yarn config set registry https://registry.npmmirror.com/

2. Download Dependencies

yarn

3. Generate the Executable File

yarn package

Developed cross-platform using Electron. You can download the source code and compile it for your platform, or use the precompiled versions directly.

Windows Platform: ApiChain_Setup_1.0.7.exe

Linux Platform: ApiChain-1.0.7.AppImage

For macOS, download the source code and compile it yourself. Refer to the Compile from Source Code section for instructions.

**If you cannot open the application on macOS, execute the command sudo spctl --master-disable in the terminal to resolve the issue. **

More content, please refer to README.md document