docs: update swagger (arkeonetwork#299)

* chore: update buf work

* docs: update config and docs

* feat: add swagger route to chain

* chore: update changelog

* chore: update docs

* fix: lint go code

Author: shreyasbhat0

CHANGELOG.md

@@ -39,6 +39,7 @@ Contains all the PRs that improved the code without changing the behaviors.
 ## Fixed 
 - Fixed code lint
 - Fixed ws client issue with event stream
+- Fixed swagger issue
 
 # v1.0.2-Prerelease 
 

app/app.go

@@ -6,7 +6,6 @@ package app
 import (
 	"fmt"
 	"io"
-	"net/http"
 	"os"
 
 	autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
@@ -64,7 +63,6 @@ import (
 
 	"github.com/arkeonetwork/arkeo/app/keepers"
 	arekoappParams "github.com/arkeonetwork/arkeo/app/params"
-	"github.com/arkeonetwork/arkeo/docs"
 
 	// distrclient "github.com/cosmos/cosmos-sdk/x/distribution/client"
 	"cosmossdk.io/x/evidence"
@@ -963,8 +961,11 @@ func (app *ArkeoApp) RegisterAPIRoutes(apiSvr *api.Server, apiConfig config.APIC
 	ModuleBasics.RegisterGRPCGatewayRoutes(clientCtx, apiSvr.GRPCGatewayRouter)
 
 	// register app's OpenAPI routes.
-	apiSvr.Router.Handle("/static/openapi.yml", http.FileServer(http.FS(docs.Docs)))
-	// apiSvr.Router.HandleFunc("/", openapiconsole.Handler(AppName, "/static/openapi.yml"))
+	if apiConfig.Swagger {
+		if err := RegisterSwaggerAPI(apiSvr); err != nil {
+			panic(err)
+		}
+	}
 }
 
 // RegisterTxService implements the Application.RegisterTxService method.

app/swagger.go

@@ -0,0 +1,18 @@
+package app
+
+import (
+	"net/http"
+
+	"github.com/cosmos/cosmos-sdk/server/api"
+
+	"github.com/arkeonetwork/arkeo/docs"
+	"github.com/arkeonetwork/arkeo/pkg/openapiconsole"
+)
+
+// RegisterSwaggerAPI provides a common function which registers swagger route with API Server
+func RegisterSwaggerAPI(apiSvr *api.Server) error {
+	// register app's OpenAPI routes.
+	apiSvr.Router.Handle("/static/swagger.min.json", http.FileServer(http.FS(docs.Docs)))
+	apiSvr.Router.HandleFunc("/swagger", openapiconsole.Handler(AppName+" Swagger UI", "/static/swagger.min.json"))
+	return nil
+}

buf.work.yaml

@@ -1,3 +1,3 @@
 version: v1
 directories:
-  - ./proto
+    - proto

docs/TESTNET.md

@@ -81,6 +81,7 @@ curl -s http://seed31.innovationtheory.com:26657/genesis | jq '.result.genesis'
    sed -i -e "s/^pruning-keep-recent *=.*/pruning-keep-recent = \"100\"/" $HOME/.arkeo/config/app.toml
    sed -i -e "s/^pruning-interval *=.*/pruning-interval = \"50\"/" $HOME/.arkeo/config/app.toml
    sed -i 's|minimum-gas-prices =.*|minimum-gas-prices = "0.001uarkeo"|g' $HOME/.arkeo/config/app.toml
+   sed -i 's|swagger =.*| swagger = true|g' $HOME/.arkeo/config/app.toml
    ```
 
 ---

docs/proto/config.json

@@ -0,0 +1,41 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "title": "Arkeo - gRPC Gateway docs",
+        "description": "A REST interface for state queries. \nUsing Cosmos SDK [{sdk-version}](https://github.com/cosmos/cosmos-sdk/releases/tag/{sdk-version})",
+        "version": "{arkeo-version}"
+    },
+    "apis": [
+       
+        {
+            "url": "./tmp-swagger-gen/arkeo/arkeo/query.swagger.json",
+            "tags": {
+                "add": ["Arkeo"]
+            },
+            "operationIds": {
+                "rename": {
+                    "Params": "ArkeoParams"
+                }
+            }
+        },
+        {
+            "url": "./tmp-swagger-gen/arkeo/claim/query.swagger.json",
+            "tags": {
+                "add": ["Claim"]
+            },
+            "operationIds": {
+                "rename": {
+                    "Params": "ClaimParams"
+                }
+            }
+        },
+        {
+            "url": "https://raw.githubusercontent.com/cosmos/cosmos-sdk/{sdk-version}/client/docs/swagger-ui/swagger.yaml",
+            "tags": {
+                "add": ["Cosmos"]
+            }
+        }
+
+       
+    ]
+}