Italia OpenAPI Schema Editor is developed on Swagger Editor.

This repository uses PNPM and turborepo for packages management, and changesets for versioning and publishing.

• 💻 Usage
• 📋 Development
• 📝 Contributing
• ⚖️ License

To launch the application, just run docker compose

• that will build and deploy the app - and open the browser

docker compose up -d app
open http://localhost:5000

To use Italia Schema Editor all you need to do is installing the @italia/schema-editor plugin and use the component in your application.

import 'bootstrap-italia/dist/css/bootstrap-italia.min.css';
import '@fontsource/lora';
import '@fontsource/roboto-mono';
import '@fontsource/titillium-web';

import './App.scss';

import { SchemaEditor } from '@italia/schema-editor';
import '@italia/schema-editor/dist/style.css';

function App() {
  const urlParams = new URLSearchParams(window.location.search);
  const schemaUrl = urlParams.get('url');

  return (
    <>
      <div className="app-container">
        <SchemaEditor
            url={schemaUrl}
            oasCheckerUrl={'https://italia.github.io/api-oas-checker/'}
            schemaEditorUrl={'Your URL here'}
        />
      </div>
    </>
  );
}

export default App;

This repository contains various usage examples:

• apps/example/src/App.tsx - Showcase webapp;
• apps/example/src/components/standalone - Standalone editor;
• apps/example/src/components/swaggerui-plugins-collection - Use the SwaggerUI component only.

To start the development environment with docker, run the following command:

docker compose up -d dev

This will run a development environment based on the dev.dockerfile and will start the development server.

Ensure to have installed PNPM package manager.

Install node modules by running

pnpm install

Then simply execute

pnpm dev

to start all packages in development mode.

When developing a new feature or performing a new bugfix the version of the package(s) must be increased. In order to process this correctly perform the following steps:

• Run pnpm changeset in the root of app in order to create a markdown containing the changes.

• Commit the generated files that are inside .changeset folder

• When the changesets files reach the "baseBranch" (actually "main"), a github action will generate a new PR with updated packages versions. Review the PR and approve merge.

• Once the PR is merged into the baseBranch, a github action will publish packages automatically.

To create images for the two webapps, run th following commands:

# Editor webapp
docker build . --target webapp --tag webapp:latest

# Showcase webapp
docker build . --target example --tag example:latest

Please, see CONTRIBUTING.md for more details on:

• using pre-commit;
• following the git flow and making good pull requests.

BSD 3-Clause License © LICENSE