A modern, interactive API documentation library built on React. Docutopia brings beautiful, type-safe API documentation to your OpenAPI specifications with a focus on simplicity and developer experience.
Docutopia simplifies creating beautiful API documentation by providing:
- Modern React architecture with clean, responsive UI
- Interactive API testing built directly into the documentation
- Multiple authentication methods (Bearer Token, API Key, Basic Auth)
- Automatic cURL generation for all API requests
- Dark mode support out of the box
@docutopia/react- React library with API documentation rendering@docutopia/fastify- Fastify plugin for serving Docutopia@docutopia/nextjs- Next.js adapter for Docutopia
Install the package:
npm install @docutopia/reactUse it in your application:
import { Docutopia } from '@docutopia/react';
function App() {
return (
<Docutopia
specUrl="https://petstore3.swagger.io/api/v3/openapi.json"
baseUrl="https://petstore3.swagger.io" // optional
/>
);
}specUrl(required) - URL to your OpenAPI specificationbaseUrl(optional) - Base URL for API requests. If not provided, uses the server URL from the OpenAPI spec
- 🎨 Beautiful UI - Modern, responsive interface with dark mode support
- 🔄 Interactive Testing - Test API endpoints directly in the documentation
- 🔐 Multiple Auth Methods - Bearer Token, API Key, and Basic Auth support
- 📋 cURL Generation - Export any request as a cURL command
- 📱 Responsive - Works seamlessly on desktop and mobile
# Clone the repository
git clone https://github.com/rhinolabs/docutopia.git
cd docutopia
# Install dependencies
pnpm install
# Build all packages
pnpm build
# Run development mode
pnpm dev
# Run linting
pnpm lintContributions are welcome! Please feel free to submit a Pull Request.
MIT