{"repo":"Teamwork/kommentaar","free":true,"listed":false,"github":"https://github.com/Teamwork/kommentaar","clone":"git clone https://github.com/Teamwork/kommentaar.git","description":"Generate documentation for Go APIs","language":"Go","stars":34,"topics":["go","openapi","documentation"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Kommentaar generates documentation for Go APIs. The primary focus is currently on OpenAPI output (previously known as Swagger), but it can also output directly to HTML, and the design allows easy addition of other output formats. Goals: - Easy to use. - Good performance. - Will not require significant code refactors to use in almost all cases. - Impossible to produce invalid OpenAPI files; prefer being strict over flexible. Non-goals: - Support every single last OpenAPI feature. Some features, such as different return values with anyOf , don't map well to how Go works, and supporting it would add much complexity and would benefit only a few users. Using the tool -------------- Install it: $ go get github.com/teamwork/kommentaar Parse one package: $ kommentaar github.com/teamwork/desk/api/v1/inboxController Or several packages: $ kommentaar github.com/teamwork/desk/api/... The default output is as an OpenAPI 2 YAML file. You can generate a HTML page with -output html , or directly serve it with -output html -serve :8080 . When serving the documentation it will rescan the source tree on every page load, making development/proofreading easier. See kommentaar -h for the full list of options. You can also the Go API, for example to serve documentation in an HTTP endpoint. Usage with Docker There is a kommentaar Docker image available at ghcr.io/teamwork/kommentaar which in some cases may simplify the setup process. It takes in the following parameters: - MODULE PATH env var (requi","default_branch":null,"files":null,"tree":[],"storefront":"/r/Teamwork","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Teamwork/kommentaar/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}