A reusable React component for visual OpenAPI editing that can be embedded in React applications.
The Apicurio OpenAPI Editor is a modern, React-based visual editor for OpenAPI specifications (version 3.0.x). It provides an intuitive interface for creating, editing, and managing OpenAPI documents without requiring direct YAML or JSON manipulation.
To quickly try out the OpenAPI Editor with a test application:
# Clone the repository
git clone https://github.com/Apicurio/apicurio-openapi-editor.git
cd apicurio-openapi-editor
# Install dependencies
npm install
# Install test app dependencies
npm run test-app:install
# Start the test application
npm run test-app:devThe test application will start on http://localhost:3000 (or the next available port). This provides a
full-featured demo of the OpenAPI Editor with sample data and all features enabled.
import { OpenAPIEditor } from '@apicurio/openapi-editor';
function App() {
const handleChange = (content: string) => {
console.log('OpenAPI content changed:', content);
};
return (
<OpenAPIEditor
initialContent={yourOpenAPIDocument}
onChange={handleChange}
/>
);
}This project is currently in early development. The initial MVP focuses on core editing features with plans to add more advanced capabilities in future releases.
Contributions are welcome! Please see CONTRIBUTING.md for details.
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.