euanwm / OpenWeightlifting

Repository that is deployed for the OpenWeightlifting site
https://www.openweightlifting.org
BSD 3-Clause "New" or "Revised" License
31 stars 21 forks source link

Implement OpenAPI generator #276

Closed euanwm closed 8 months ago

euanwm commented 9 months ago

Pretty self-explanatory, currently the backend API server has almost zero documentation and is almost entirely dependent on people who know the internal workings of each endpoint, aka me.

Go forth and implement the following thing... https://github.com/swaggo/gin-swagger

euanwm commented 8 months ago

Also take a look at this...

https://github.com/marketplace/actions/swagger-ui-action

Might save the hassle of hosting it on the backend server along with making it more accessible to the FE devs.