feat: add Swagger documentation and registration endpoint (#1)

* feat: add Swagger documentation and registration endpoint

- Implemented Swagger initialization in the Makefile and main.go
- Created Swagger documentation for the Portfolio Builder API
- Added RegisterInput, RegisterResponse, and ErrorResponse models
- Enhanced the Register handler with Swagger annotations
- Updated routes to include Swagger UI endpoint

* feat: add health check endpoint with Swagger documentation

* feat: add CRUD operations and export functionality for projects with Swagger documentation

* docs: update README to include API documentation section with Swagger link

* feat: add health check endpoint and update API paths in Swagger documentation

Author: jordan-cod

Makefile

@@ -15,6 +15,9 @@ run: build
 dev:
 	air
 
+swagger:
+	swag init -g cmd/main.go
+
 clean:
 	rm -rf $(BIN_DIR)
 

cmd/main.go

@@ -9,8 +9,15 @@ import (
 	"portfolio-backend/internal/routes"
 
 	"github.com/gin-gonic/gin"
+
+	_ "portfolio-backend/docs"
 )
 
+// @title Portfolio Builder API
+// @version 1.0
+// @description Uma API open source para o gerenciamento de portfólios de desenvolvedores.
+// @host localhost:8080
+// @BasePath /api
 func main() {
 	config.LoadEnv()