webscope

Webscope

WARNING: Webscope is very much work-in-progress. Expect bugs, and breaking changes.

Webscope is lightweight API documentation tool that generates static HTML from markdown and openapi files.

Webscope was created because I could not find tools that do all of the following:

• Generating separate pages for openapi spec, general documentation, an changelog.
• Generate static HTML that can be served from an HTTP server, or CDN (no, I do not want to host a separate React app just for a few documentation pages)
• Is free and open source

Usage

You can use it as a CLI, to generate documentation html files.

go install gitlab.com/manabug/webscope/cmd/webscope@latest
webscope -i webscope.yaml

There is also an option to serve the documentation from a Go HTTP server. See the http server example. To see it in action, run the make example-server command, and go to http://localhost:5000/docs/api.