react-openapi-form

Welcome to react-openapi-form. This is a thin wrapper around rjsf.

Goals:

• Make it easy to use rjsf with openapis with minimal configuration.
• Ability to work with remote openapis as well as imported ones.
• Type-safety

Non-goals:

• Things not mentioned at 'goals'.
• Things rjsf does sufficiently well. This thing should be complementary and not replace anything.

Installation

Install:

npm i react-openapi-form

Usage

import { OpenapiForm } from "react-openapi-form";
import "react-openapi-form/css.css";
// Your openapi
import openapi from "../public/openapi.json";

const Page = () => {
  return (
    <OpenapiForm openapi={openapi} path="/root/createDatabase" method="post" />
  );
};
export default Page;

TODO

• ✅ Extrahere OpenapiForm into react-openapi-form npm package and repo.
• ✅ Make a good readme with goals/non-goals
• ✅ Make OpenapiForm installation and usage docs good.
• ✅ Fix theming
• ✅ Allow for default values and doing stuff with response
• ✅ Add possibility for extra UI to be provided.
• Ensure the form gets submitted properly.

Wishlist

• Be unopinionated about the theming: Make it possible to provide your own Form settings so all rsjf features don't get forgotten. We can do this by decoupling rendering from this package into a prop.