API Design

APIGit utilizes the widely accepted and supported OpenAPI specification 3.0.x as the standard for defining REST APIs in the industry. Our self-developed, easy-to-use, fully visualized OpenAPI editor allows you to write API specifications quickly and easily, without needing any prior knowledge of the OpenAPI specification. The visual interface makes it simple for anyone to understand and create API documentation, streamlining the development process and enabling you to focus on creating high-quality APIs that adhere to industry standards.

API Spec view mode - default
In view mode, you can view API documents with a visually pleasing design theme. Additionally, you have the option to switch to the original swagger theme based on your preference. The API specification will appear identical when published. By clicking the 'Edit' button, you can enter the API editing mode.
API Spec view mode - swagger-ui view
In swagger view mode, you can view the API specification in the swagger theme, allowing you to easily understand and interact with the API documentation in the standard format.
API Spec view mode - code view
In code mode, the raw, plain API specification content is displayed, providing a direct view of the underlying code.
API Spec view mode - diff view
In diff view mode, you can compare one API specification with another and easily identify the differences between them.

API spec editing mode - Form view
By clicking the 'Edit' button, an API specification enters form edit mode, making it the simplest way to make modifications to the API. This mode does not require any knowledge of OpenAPI as the specification is fully visualized, making it easy to understand and edit.
API spec editing mode - code view
In code mode, you can view the raw API document content, making it easy for you to make direct edits or troubleshoot any issues with the specification.
API spec editing mode - diff view
In diff mode, you can compare the current version of the API specification being edited to its original version, and make direct edits to the content. This allows you to easily identify and resolve any differences between the two versions, making sure that the changes are accurate and aligned with the original version.

Create or Upload API spec
Our platform offers the ability to create an empty API specification or to upload an existing one to the repository. Additionally, we support the option to upload an HAR file, which will automatically convert it to an API specification.