Skip to content

Set up public API documentation

We want to use the OpenAPI standard for this. Currently, oasgen looks like the best way to generate a spec.

  • Research and integrate a suitable viewer for documentation
  • Automatically generate OpenAPI spec
  • All of our API is public; there is no backwards compatibility for now
  • The client talks to the server using shared struct definitions in the api crate, the openAPI documentation is only intended for third-party usage
Edited by Rafael Epplée
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information