docs: add more examples (JWT, file-upload, CORS)

Nexus · Nexus · commit bf7c22b21ba8 · 2026-03-01T13:50:07.000+08:00
- Add JWT authentication example
- Add file upload example
- Add CORS configuration example
- Update examples README
diff --git a/example/README.md b/example/README.md
@@ -1,8 +1,63 @@
-# DotWeb
-Simple and easy go web micro framework
+# DotWeb Examples
 
-More examples: https://github.com/devfeel/dotweb-example
+This directory contains various examples demonstrating dotweb features.
 
-## Contact Us
-#### QQ-Group：193409346 - <a target="_blank" href="http://shang.qq.com/wpa/qunwpa?idkey=836e11667837ad674462a4a97fb21fba487cd3dff5b2e1ca0d7ea4c2324b4574"><img border="0" src="http://pub.idqqimg.com/wpa/images/group.png" alt="Golang-Devfeel" title="Golang-Devfeel"></a>
-#### Gitter：[![Gitter](https://badges.gitter.im/devfeel/dotweb.svg)](https://gitter.im/devfeel-dotweb/wechat)
+## Available Examples
+
+### 1. Basic Usage
+Simple web server setup with routing.
+
+```go
+// See main.go
+```
+
+### 2. JWT Authentication
+Demonstrates JWT token-based authentication.
+
+```go
+// See jwt/main.go
+```
+
+Run:
+```bash
+cd jwt
+go run main.go
+```
+
+### 3. File Upload
+Shows how to handle file uploads.
+
+```go
+// See file-upload/main.go
+```
+
+Run:
+```bash
+cd file-upload
+go run main.go
+```
+
+### 4. CORS
+Cross-Origin Resource Sharing configuration.
+
+```go
+// See cors/main.go
+```
+
+Run:
+```bash
+cd cors
+go run main.go
+```
+
+## Running Examples
+
+```bash
+# Run any example
+cd example/<name>
+go run main.go
+```
+
+## More Examples
+
+Visit [dotweb-example](https://github.com/devfeel/dotweb-example) for more complete examples.
diff --git a/example/cors/main.go b/example/cors/main.go
@@ -0,0 +1,48 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/devfeel/dotweb"
+)
+
+// CORS Example
+// This demonstrates how to handle Cross-Origin Resource Sharing (CORS)
+
+func main() {
+	// init DotApp
+	app := dotweb.New()
+
+	// API endpoint with CORS headers
+	app.HttpServer.GET("/api/data", func(ctx dotweb.Context) error {
+		// Set CORS headers
+		ctx.Response().Header().Set("Access-Control-Allow-Origin", "*")
+		ctx.Response().Header().Set("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS")
+		ctx.Response().Header().Set("Access-Control-Allow-Headers", "Content-Type, Authorization")
+
+		return ctx.WriteJson(map[string]interface{}{
+			"message": "Hello from API",
+			"data":     []string{"item1", "item2", "item3"},
+		})
+	})
+
+	// POST endpoint
+	app.HttpServer.POST("/api/data", func(ctx dotweb.Context) error {
+		// Set CORS headers
+		ctx.Response().Header().Set("Access-Control-Allow-Origin", "*")
+		ctx.Response().Header().Set("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS")
+		ctx.Response().Header().Set("Access-Control-Allow-Headers", "Content-Type, Authorization")
+
+		return ctx.WriteJson(map[string]string{
+			"status":  "success",
+			"message": "Data received",
+		})
+	})
+
+	fmt.Println("CORS Example server starting on :8080")
+	fmt.Println("API endpoint: GET /api/data")
+	fmt.Println("API endpoint: POST /api/data")
+	fmt.Println("Test with: curl -H 'Origin: *' http://localhost:8080/api/data")
+	err := app.StartServer(8080)
+	fmt.Println("server error => ", err)
+}
diff --git a/example/file-upload/main.go b/example/file-upload/main.go
@@ -0,0 +1,88 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"time"
+
+	"github.com/devfeel/dotweb"
+)
+
+// File Upload Example
+// This demonstrates how to handle file uploads with dotweb
+
+func main() {
+	// init DotApp
+	app := dotweb.New()
+
+	// Set upload directory
+	uploadDir := "./uploads"
+	if err := os.MkdirAll(uploadDir, 0755); err != nil {
+		fmt.Println("Error creating upload dir:", err)
+		return
+	}
+
+	// Show upload form
+	app.HttpServer.GET("/upload", func(ctx dotweb.Context) error {
+		return ctx.WriteString(`
+<!DOCTYPE html>
+<html>
+<head><title>File Upload</title></head>
+<body>
+<form enctype="multipart/form-data" method="post" action="/upload">
+<input type="file" name="file"><br>
+<input type="submit" value="Upload">
+</form>
+</body>
+</html>
+		`)
+	})
+
+	// Handle file upload
+	app.HttpServer.POST("/upload", func(ctx dotweb.Context) error {
+		file, err := ctx.Request().FormFile("file")
+		if err != nil {
+			return ctx.WriteString("Error uploading file: " + err.Error())
+		}
+
+		// Generate unique filename
+		filename := fmt.Sprintf("file_%d%s", time.Now().Unix(), file.GetFileExt())
+		serverPath := fmt.Sprintf("%s/%s", uploadDir, filename)
+
+		// Save file
+		size, err := file.SaveFile(serverPath)
+		if err != nil {
+			return ctx.WriteString("Error saving file: " + err.Error())
+		}
+
+		return ctx.WriteJson(map[string]interface{}{
+			"message":    "File uploaded successfully",
+			"filename":   filename,
+			"size":       size,
+			"contentType": file.Header.Header.Get("Content-Type"),
+		})
+	})
+
+	// List uploaded files
+	app.HttpServer.GET("/files", func(ctx dotweb.Context) error {
+		files, err := os.ReadDir(uploadDir)
+		if err != nil {
+			return ctx.WriteString("Error reading files")
+		}
+
+		var fileList []string
+		for _, f := range files {
+			if !f.IsDir() {
+				fileList = append(fileList, f.Name())
+			}
+		}
+		return ctx.WriteJson(fileList)
+	})
+
+	fmt.Println("File Upload Example server starting on :8080")
+	fmt.Println("Upload form: GET /upload")
+	fmt.Println("Upload handler: POST /upload")
+	fmt.Println("List files: GET /files")
+	err := app.StartServer(8080)
+	fmt.Println("server error => ", err)
+}
diff --git a/example/jwt/main.go b/example/jwt/main.go
@@ -0,0 +1,60 @@
+package main
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/devfeel/dotweb"
+)
+
+// JWT Middleware Example
+// This demonstrates how to use JWT authentication with dotweb
+
+func main() {
+	// init DotApp
+	app := dotweb.New()
+
+	// Set route
+	app.HttpServer.GET("/api/public", func(ctx dotweb.Context) error {
+		return ctx.WriteString("This is a public endpoint")
+	})
+
+	// Protected route - in real app, add JWT validation middleware
+	app.HttpServer.GET("/api/private", func(ctx dotweb.Context) error {
+		return ctx.WriteJson(map[string]interface{}{
+			"message": "This is a private endpoint",
+			"user":    "admin",
+		})
+	})
+
+	// Login endpoint - returns simple token (use proper JWT in production)
+	app.HttpServer.POST("/api/login", func(ctx dotweb.Context) error {
+		// In production, validate credentials from database
+		username := ctx.PostFormValue("username")
+		password := ctx.PostFormValue("password")
+
+		// Simple validation (replace with real auth)
+		if username == "admin" && password == "password" {
+			// Generate simple token (use proper JWT library in production)
+			token := generateSimpleToken(username)
+			return ctx.WriteJson(map[string]string{
+				"token": token,
+			})
+		}
+		return ctx.WriteString("Invalid credentials")
+	})
+
+	fmt.Println("JWT Example server starting on :8080")
+	fmt.Println("Public endpoint: GET /api/public")
+	fmt.Println("Private endpoint: GET /api/private")
+	fmt.Println("Login: POST /api/login?username=admin&password=password")
+	err := app.StartServer(8080)
+	fmt.Println("server error => ", err)
+}
+
+// generateSimpleToken creates a simple token (for demonstration only)
+// In production, use: github.com/golang-jwt/jwt
+func generateSimpleToken(username string) string {
+	exp := time.Now().Add(time.Hour).Unix()
+	return fmt.Sprintf("%s.%d.%s", username, exp, "signature")
+}
