Updated November 13, 2026: APIGit uses Redoc 3 for API references. The separate Swagger UI viewer has been removed, while Swagger 2.0 file imports remain supported. This tutorial now follows the current OpenAPI editor and Try It Out flow.
An existing Swagger 2.0 file can still be the starting point for your API on APIGit. Import it into your repository; APIGit converts it to OpenAPI 3.0 for editing and saves the converted spec when you commit. You can also create a new OpenAPI spec directly.
Click + above the file tree and choose OpenAPI Spec. Create a starter file or choose import openAPI spec to upload JSON or YAML. Give it a repository path such as openapi/orders.yaml.
The same dialog also creates AsyncAPI documents and GraphQL schemas. This tutorial uses OpenAPI because Form editing and Try It Out apply to that format.
Open the file in edit mode and select Code. The editor uses the full panel. A small OpenAPI document might look like this:
openapi: 3.0.3
info:
title: Orders API
version: 1.0.0
servers:
- url: https://api.example.com/v1
tags:
- name: Orders
description: Read customer orders
paths:
/orders/{id}:
get:
operationId: getOrder
summary: Get an order
tags: [Orders]
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: The order
content:
application/json:
schema:
type: object
properties:
id:
type: string
status:
type: string
example:
id: order-42
status: shipped
The server URL is the API's base address. Tags group related operations. A path combines an HTTP method, parameters and the responses clients should expect. Replace the example server with your own service, or publish an OpenAPI mock server to answer from the example.

Form edits the same OpenAPI document through structured fields. Diff compares your draft with the previous content. Governance checks it against a ruleset. Preview renders your current edits with Redoc 3, as readers will see the reference.
There is one renderer; you no longer select Swagger UI or see a Swagger preview beside the code editor.

In the rendered OpenAPI reference, click TRY IT on the operation, enter the parameter values, and choose Send Request. Examine the response status, headers and body. Try It Out is available on every plan and must be enabled for a published version.

Review and commit your changes, then publish an API document to share the reference. See Supported API Formats for what differs when documenting AsyncAPI or GraphQL.
AsyncAPI browser governance, hosted GraphQL mocks and generated agent pages are live. See the workflows and limits, with AsyncAPI and GraphQL lint in CLI 0.6.0 and hosted server lint availability tracked separately.
Create, edit and publish AsyncAPI documents and GraphQL schemas alongside OpenAPI. One Redoc 3 viewer, full-panel code editing and a clear guide to what each format supports.
This article explains the different components of a REST API by following a request from end to end. An API client is responsible for assembling and directing an API request to the API server. An API request to a REST API consists of an endpoint, method, parameters, request headers, and a request body. The API server handles authentication, validates input data, retrieves or manipulates data from a database, and returns the appropriate response to the client. An API response typically includes a status code, response headers, and a body. API status codes are used to provide information to the client about the outcome of the request and to help the client understand how to proceed. Response headers and bodies provide additional information and data about the response.
Create a free workspace, add an OpenAPI file and publish your first API document and mock server in minutes.