Skip to content

Improve OpenAPI (REST) documentation for the website with a docusaurus plugin #1001

Open
@rikoe

Description

@rikoe

The App Directory documentation uses a generated ReDoc static html file for the API docs, based on appd.yaml, but docusaurus now have several nice plugins for integrating OpenAPI documentation which we should incorporate.

One of them is https://github.com/cloud-annotations/docusaurus-openapi (example: https://docusaurus-openapi.netlify.app/).

The other is https://github.com/rohit-gohri/redocusaurus (example: https://redocusaurus.vercel.app/).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions