Merge pull request #732 from cybercongress/v3-swagger-update

Swagger and openapi update

Makefile

@@ -160,10 +160,9 @@ proto-format:
 	--workdir /workspace $(PROTO_FORMATTER_IMAGE) \
 	find ./ -name *.proto -exec clang-format -i {} \;
 
-# TODO update swagger gen
-#proto-swagger-gen:
-#	@#echo "Generating Protobuf Swagger"
-#	@./scripts/protoc-swagger-gen.sh
+proto-swagger-gen:
+	@echo "Generating Protobuf Swagger OpenAPI"
+	@./scripts/protoc_swagger_openapi_gen.sh
 
 proto-lint:
 	@$(DOCKER_BUF) lint --error-format=json

app/app.go

@@ -2,6 +2,7 @@ package app
 
 import (
 	"fmt"
+	"github.com/cybercongress/go-cyber/v3/client/docs"
 	"io"
 	"os"
 	"strings"
@@ -71,6 +72,7 @@ import (
 
 const (
 	appName = "BostromHub"
+	Name    = "bostrom"
 )
 
 // We pull these out so we can set them with LDFLAGS in the Makefile
@@ -437,6 +439,9 @@ func (app *App) RegisterAPIRoutes(apiSvr *api.Server, apiConfig config.APIConfig
 	// Register legacy and grpc-gateway routes for all modules.
 	ModuleBasics.RegisterRESTRoutes(clientCtx, apiSvr.Router)
 	ModuleBasics.RegisterGRPCGatewayRoutes(clientCtx, apiSvr.GRPCGatewayRouter)
+
+	// register app's OpenAPI routes.
+	docs.RegisterOpenAPIService(Name, apiSvr.Router)
 }
 
 // RegisterTxService implements the Application.RegisterTxService method.

client/docs/docs.go

@@ -0,0 +1,40 @@
+package docs
+
+import (
+	"embed"
+	httptemplate "html/template"
+	"net/http"
+
+	"github.com/gorilla/mux"
+)
+
+const (
+	apiFile   = "/static/openapi.yml"
+	indexFile = "template/index.tpl"
+)
+
+//go:embed static
+var Static embed.FS
+
+//go:embed template
+var template embed.FS
+
+func RegisterOpenAPIService(appName string, rtr *mux.Router) {
+	rtr.Handle(apiFile, http.FileServer(http.FS(Static)))
+	rtr.HandleFunc("/", handler(appName))
+}
+
+// handler returns an http handler that servers OpenAPI console for an OpenAPI spec at specURL.
+func handler(title string) http.HandlerFunc {
+	t, _ := httptemplate.ParseFS(template, indexFile)
+
+	return func(w http.ResponseWriter, req *http.Request) {
+		t.Execute(w, struct {
+			Title string
+			URL   string
+		}{
+			title,
+			apiFile,
+		})
+	}
+}