apis.as
Preview MDXLD as API documentation with try-it console
apis.as - API Documentation
Preview MDXLD API definitions with interactive documentation and try-it console through apis.as.
What is apis.as?
apis.as renders MDXLD documents with $type: API as beautiful, interactive API documentation with built-in testing console.
Basic Example
---
$type: API
$id: https://apis.do/users-api
title: Users API
version: 1.0.0
baseUrl: https://api.example.com
auth: bearer
endpoints:
- method: GET
path: /users
description: List all users
params:
- name: limit
type: number
default: 10
- name: offset
type: number
default: 0
- method: POST
path: /users
description: Create a new user
body:
name: string
email: string
---
# Users API
RESTful API for managing users.
## Authentication
All requests require a Bearer token in the Authorization header.Renders at: https://apis.as/users-api
Features
- Interactive Docs: Try endpoints directly in browser
- Code Examples: Auto-generated in multiple languages
- Schema Validation: Request/response validation
- Authentication: Built-in auth testing
- Mocking: Mock responses for development
- OpenAPI: Generates OpenAPI/Swagger spec
API Definition
---
$type: API
title: Products API
endpoints:
- method: GET
path: /products
query:
category: string
minPrice: number
maxPrice: number
response:
type: array
items:
$type: Product
id: string
name: string
price: number
---Try-It Console
Users can test endpoints directly:
GET /users?limit=5
Authorization: Bearer {token}
Response:
{
"users": [...]
}Preview URL
Try It
# Deploy API docs
mdxe deploy users-api.mdx --preview apis.as
# Opens: https://apis.as/users-api