From 582ca6d8976a462f995dd9c036f49fcc14f9afdb Mon Sep 17 00:00:00 2001 From: EwenQuim Date: Thu, 22 Feb 2024 23:59:40 +0100 Subject: [PATCH] docs: added std example to readme and middleware with correct syntax to docs page --- README.md | 30 ++++++++++++++++++++++++ documentation/docs/guides/middlewares.md | 2 +- go.work.sum | 1 + 3 files changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 50ca66bf..27d647bb 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,36 @@ func main() { } ``` +### Std lib compatibility + +```go +package main + +import ( + "net/http" + "github.com/go-fuego/fuego" +) + +func main() { + s := fuego.NewServer() + + // Standard net/http middleware + fuego.Use(s, func(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("X-Hello", "World") + next.ServeHTTP(w, r) + }) + }) + + // Standard net/http handler with automatic OpenAPI route declaration + fuego.GetStd(s, "/std", func(w http.ResponseWriter, r *http.Request) { + w.Write([]byte("Hello, World!")) + }) + + s.Run() +} +``` +
All features diff --git a/documentation/docs/guides/middlewares.md b/documentation/docs/guides/middlewares.md index ae06d8db..1eb10e03 100644 --- a/documentation/docs/guides/middlewares.md +++ b/documentation/docs/guides/middlewares.md @@ -56,7 +56,7 @@ func main() { // Add a middleware to a group of routes api := s.Group(s, "/api") - api.Use(func(next http.Handler) http.Handler { + fuego.Use(api, func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { // Do something before the request // Only affects routes in the group diff --git a/go.work.sum b/go.work.sum index b6d55f7a..dff763dc 100644 --- a/go.work.sum +++ b/go.work.sum @@ -179,6 +179,7 @@ github.com/shopspring/decimal v1.2.0/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFR github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/sirupsen/logrus v1.9.2/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= github.com/snowflakedb/gosnowflake v1.6.19/go.mod h1:FM1+PWUdwB9udFDsXdfD58NONC0m+MlOSmQRvimobSM= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=