API Playground
Configuration
API Playground
Configuration
Set up documentation for your API endpoints
Setting the API metadata
Setting the api field in the page’s metadata will enable the API playground.
---
title: "Create new user"
api: "POST https://api.mintlify.com/user"
---
Method
This can be any one of the following REST API methods:
| Method | Description |
|---|---|
GET | Retrieve information about the REST API resource |
POST | Create a REST API resource |
PUT | Update a REST API resource |
PATCH | Update a REST API resource |
DELETE | Delete a REST API resource or related component |
Endpoint
The endpoint should point to the API that the playground should call. For example, it can be something like
https://api.example.com/v1/endpoint
If you have baseUrl configured in mint.json, you can use relative paths like /v1/endpoint.
OpenAPI
Mintlify also supports OpenAPI and Swagger files.
---
title: "Get users"
openapi: "GET /users"
---
Learn more at the OpenAPI guide.