Add openapi API documentation (#294)

* Initial version

- Add OpenAPI documentation generator
- Update README.md to remove endpoint documentations

* Adds new endpoints

- Fixes build with swag
- Adds new endpoints

* Adds more endpoints documentation

- Also removes swag from Dockerfile and build script

* Finally adds all endpoints documentation

* Initial version

- Add OpenAPI documentation generator
- Update README.md to remove endpoint documentations

* Adds new endpoints

- Fixes build with swag
- Adds new endpoints

* Adds more endpoints documentation

- Also removes swag from Dockerfile and build script

* Finally adds all endpoints documentation

* Update README (#1)

* Update README

I completely redid the `README.md`. Now it's much easier to read and understand.

---------

Co-authored-by: cocool97 <34218602+cocool97@users.noreply.github.com>

* Improves documentation

* Delete server/config.db

* Update README.md

* Update README.md

* fix download in api docs

* add api docs to web

---------

Co-authored-by: Shadeov <144587546+shadeov@users.noreply.github.com>
Co-authored-by: nikk gitanes <tsynik@gmail.com>

server/web/api/settings.go

@@ -5,9 +5,10 @@ import (
 
 	"server/rutor"
 
+	"server/dlna"
+
 	"github.com/gin-gonic/gin"
 	"github.com/pkg/errors"
-	"server/dlna"
 
 	sets "server/settings"
 	"server/torr"
@@ -19,6 +20,19 @@ type setsReqJS struct {
 	Sets *sets.BTSets `json:"sets,omitempty"`
 }
 
+// settings godoc
+//
+//	@Summary		Get / Set server settings
+//	@Description	Allow to get or set server settings.
+//
+//	@Tags			API
+//
+//	@Param			request	body	setsReqJS	true	"Settings request"
+//
+//	@Accept			json
+//	@Produce		json
+//	@Success		200	{object}	sets.BTSets	"Depends on what action has been asked"
+//	@Router			/settings [post]
 func settings(c *gin.Context) {
 	var req setsReqJS
 	err := c.ShouldBindJSON(&req)