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.
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 scalar
The advantages of this are:
docs are much more comprehensive and specific
in sync with code base
API docs have a UI for sending requests so it is easy to test our API and try things out
The openapi specification could possibly in the future be used to automatically test our API, without us having to write test cases for everything
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 scalar
The advantages of this are:
Screenshots