@overtrue/pivot

Pivot

A modern React component library for visualizing and interacting with OpenAPI specifications.

Features

• 🚀 Full support for OpenAPI 3.x specifications
• 🎨 Beautiful and responsive UI components
• ⚡️ Interactive "Try it out" functionality
• 📦 Lightweight and tree-shakable

Installation

npm install @overtrue/pivot
# or
yarn add @overtrue/pivot

Basic Usage

import { OpenApiLayout } from '@overtrue/pivot';
import spec from './openapi-spec.json';

function App() {
  return <OpenApiLayout spec={spec} />;
}

Components

OpenApiLayout

The main layout component that renders the complete OpenAPI documentation.

TryItOutPanel

Standalone component for making API requests:

import { TryItOutPanel } from '@overtrue/pivot';

function TestPage() {
  return (
    <TryItOutPanel
      operation={operationObject}
      method="post"
      path="/api/users"
    />
  );
}

Development

# Install dependencies
npm install

# Build the library
npm run build

License

MIT