The OpenMicrofrontends project aims to provide a formal specification for Microfrontends provided by a server. Think of it as OpenAPI for Microfrontends.
The project just released version 1.0.0 of the specification and a generator to create type-safe integration code on the Microfrontend- and the Host Application-side.
Example Description:
$schema: https://open-microfrontends.org/schemas/1-0-0.json
openMicrofrontends: 1.0.0
servers:
- url: 'http://localhost:7890'
description: Local Test Server
microfrontends:
- name: My First Microfrontend
assets:
basePath: /public
js:
moduleSystem: ESM
initial:
- Microfrontend.js
rendererFunctionName: startMyFirstMicrofrontend
config:
schema:
type: object
properties:
welcomeMessage:
type: string
required: ["welcomeMessage"]
default:
welcomeMessage: Hello World!
messages:
ping:
publish: true
subscribe: true
schema:
type: object
properties:
ping:
const: true
required: ["ping"]
Find out more on the project homepage.
Top comments (0)