add swag && proto examples

2022-03-08 22:09:04 +08:00
parent 2c8ba685a3
commit b8656937f6
12 changed files with 1638 additions and 32 deletions
--- a/go/fizz_example/main.go
+++ b/go/fizz_example/main.go
@@ -0,0 +1,103 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"net/http"
+
+	"github.com/gin-contrib/cors"
+	"github.com/gin-gonic/gin"
+
+	"github.com/loopfz/gadgeto/tonic"
+
+	"github.com/wI2L/fizz"
+	"github.com/wI2L/fizz/openapi"
+)
+
+func main() {
+	router, err := NewRouter()
+	if err != nil {
+		log.Fatal(err)
+	}
+	srv := &http.Server{
+		Addr:    ":4242",
+		Handler: router,
+	}
+	_ = srv.ListenAndServe()
+}
+
+// NewRouter returns a new router for the
+// Pet Store.
+func NewRouter() (*fizz.Fizz, error) {
+	engine := gin.New()
+	engine.Use(cors.Default())
+
+	fizz := fizz.NewFromEngine(engine)
+
+	// Override type names.
+	// fizz.Generator().OverrideTypeName(reflect.TypeOf(Fruit{}), "SweetFruit")
+
+	// Initialize the informations of
+	// the API that will be served with
+	// the specification.
+	infos := &openapi.Info{
+		Title:       "Fruits Market",
+		Description: `This is a sample Fruits market server.`,
+		Version:     "1.0.0",
+	}
+	// Create a new route that serve the OpenAPI spec.
+	fizz.GET("/openapi.json", nil, fizz.OpenAPI(infos, "json"))
+	fizz.GET("/doc", nil, func(ctx *gin.Context) {
+		ctx.Status(200)
+		ctx.Header("Content-Type", "text/html")
+		ctx.String(200, rapidoc)
+	})
+
+	// Setup routes.
+	routes(fizz.Group("/market", "market", "Your daily dose of freshness"))
+
+	if len(fizz.Errors()) != 0 {
+		return nil, fmt.Errorf("fizz errors: %v", fizz.Errors())
+	}
+	return fizz, nil
+}
+
+func routes(grp *fizz.RouterGroup) {
+	// Add a new fruit to the market.
+	grp.POST("", []fizz.OperationOption{
+		fizz.Summary("Add a fruit to the market"),
+		fizz.Response("400", "Bad request", nil, nil,
+			map[string]interface{}{"error": "fruit already exists"},
+		),
+	}, tonic.Handler(CreateFruit, 200))
+
+	// Remove a fruit from the market,
+	// probably because it rotted.
+	grp.DELETE("/:name", []fizz.OperationOption{
+		fizz.Summary("Remove a fruit from the market"),
+		fizz.ResponseWithExamples("400", "Bad request", nil, nil, map[string]interface{}{
+			"fruitNotFound": map[string]interface{}{"error": "fruit not found"},
+			"invalidApiKey": map[string]interface{}{"error": "invalid api key"},
+		}),
+	}, tonic.Handler(DeleteFruit, 204))
+
+	// List all available fruits.
+	grp.GET("", []fizz.OperationOption{
+		fizz.Summary("List the fruits of the market"),
+		fizz.Response("400", "Bad request", nil, nil, nil),
+		fizz.Header("X-Market-Listing-Size", "Listing size", fizz.Long),
+	}, tonic.Handler(ListFruits, 200))
+}
+
+const rapidoc = `
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
+  </head>
+  <body>
+    <rapi-doc spec-url=/openapi.json render-style="view"> </rapi-doc>
+  </body>
+</html>
+`