API documentation generator for the OpenCloud Groupware backend service
  • Go 99.8%
  • Makefile 0.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-04-29 15:03:14 +02:00
internal deal with the jmap.Result[T] type added in 19b1ed751 2026-04-29 15:03:14 +02:00
.gitignore update README with usage instructions 2026-01-22 10:35:20 +01:00
go.mod add support for default values, and turning [RFC????] into links 2026-02-03 21:48:14 +01:00
go.sum add support for default values, and turning [RFC????] into links 2026-02-03 21:48:14 +01:00
LICENSE add ASL2 license 2025-12-10 09:42:43 +01:00
main.go support response definitions in template functions 2026-04-22 17:21:41 +02:00
Makefile implement improved support for examples, differentiating between requests and responses 2026-01-13 16:42:30 +01:00
README.md update README with usage instructions 2026-01-22 10:35:20 +01:00

OpenCloud Groupware API Documentation Generator

The purpose of this tool is to analyze the OpenCloud Groupware backend source code to extract information about the REST APIs it exposes, and to render those into OpenAPI.

The motivation for implementing a piece of custom software to do so is to avoid repetition and other error prone practices that are required by the use of a generic solution such as go-swagger, and instead making use of the conventions as well as the understanding of the underlying framework implemented in the Groupware backend in order to minimize annotation efforts.

Usage

Build groupware-apidocs and put it somewhere in your PATH:

go build
ln -s "$PWD/groupware-apidocs" ~/.local/bin/

Then execute the following make target in the OpenCloud source tree:

make -C ./services/groupware/ api.html

That will create a Redoc bundle of the Groupware OpenAPI, which you can then enjoy using your favourite web browser:

firefox ./services/groupware/api.html