> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-docs-simplify-quickstart-2510244c.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAPI Setup

> Reference OpenAPI endpoints in your docs pages

## Add Your OpenAPI Specification

To get started, you'll need a valid OpenAPI document (version 3.0+) in either JSON or YAML format that follows the [OpenAPI specification](https://swagger.io/specification/).

## Configure Your Documentation

There are two main ways to add OpenAPI documentation:

### 1. Auto-generate API Pages (Recommended)

The simplest way to get started is to add an `openapi` field to your `mint.json`. This can be either:

* A path to your OpenAPI file in your docs repo
* A URL to a hosted OpenAPI document

```json
{
  "anchors": [
    {
      "name": "API Reference",
      "openapi": "/path/to/openapi.json",
      "url": "api-reference",
      "icon": "square-terminal"
    }
  ]
}
```

Mintlify will automatically generate pages for each API endpoint.

### 2. Create Custom API Pages

For more customization, you can create individual MDX pages for your API endpoints:

```md
---
title: "Get users"
openapi: "GET /users"
---
```

<Note>
  For large APIs, you can auto-generate MDX files using our scraping tool:

  ```bash
  npx @mintlify/scraping@latest openapi-file <path-to-openapi-file> -o api-reference
  ```
</Note>