ausocean / openfish

OpenFish is an open-source system written in GoLang for classifying marine species. Tasks involve importing video or image data, classifying and annotating data (both manually and automatically), searching, and more. It is expected that OpenFish will use utilize computer vision and machine learning techniques.
https://ausocean.github.io/openfish/
Other
6 stars 0 forks source link

Auto generate our API docs #164

Open scott97 opened 1 week ago

scott97 commented 1 week ago

Depends on https://github.com/ausocean/openfish/pull/180

API documentation takes a bit of time to write and it sometimes gets out of sync with the code.

This PR generates our API docs automatically by adding additional comments to our code. Swaggo is used to create an openapi specification, and the docs are displayed using https://github.com/enzonotario/vitepress-theme-openapi

The advantages of this are:

The downsides are:

Screenshots

image