📝 Update Swagger doc

SkyPierIO · Feb 25, 2024 · aadc944 · aadc944
1 parent be241ad
commit aadc944
Show file tree

Hide file tree

Showing 6 changed files with 126 additions and 16 deletions.
diff --git a/cmd/skypier-vpn-node/main.go b/cmd/skypier-vpn-node/main.go
@@ -1,6 +1,7 @@
 package main
 
 import (
+	"log"
 	"strconv"
 
 	docs "github.com/SkyPierIO/skypier-vpn/pkg/docs"
@@ -14,11 +15,11 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
-// @title           Swagger Skypier API
-// @version         1.0
-// @description     This is a Skypier VPN REST API.
+// @title           Skypier
+// @version         0.0.1
+// @description     Skypier - Embark securely on web3
 
-// @contact.name   Skypier info
+// @contact.name   Skypier
 // @contact.url    http://skypier.io/
 // @contact.email  [email protected]
 
@@ -57,6 +58,7 @@ func main() {
 	if config.SwaggerEnabled {
 		docs.SwaggerInfo.BasePath = "/api/v0"
 		router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
+		log.Println("Swagger UI available at http://127.0.0.1:8081/swagger/index.html")
 	}
 
 	api := router.Group("/api/v0")
@@ -67,6 +69,7 @@ func main() {
 		c.String(200, "pong")
 	})
 	api.GET("/getConfig", utils.GetConfiguration)
+	api.GET("/id", vpn.GetPeerId)
 
 	// Run with HTTP
 	router.Run("0.0.0.0:" + strconv.FormatUint(uint64(innerConfig.Port), 10))

diff --git a/pkg/docs/docs.go b/pkg/docs/docs.go
@@ -10,7 +10,7 @@ const docTemplate = `{
         "description": "{{escape .Description}}",
         "title": "{{.Title}}",
         "contact": {
-            "name": "Skypier info",
+            "name": "Skypier",
             "url": "http://skypier.io/",
             "email": "[email protected]"
         },
@@ -48,6 +48,32 @@ const docTemplate = `{
                     }
                 }
             }
+        },
+        "/id": {
+            "get": {
+                "description": "Get the local libp2p peer ID (this is the identity of your node on the Skypier Network)",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "P2P"
+                ],
+                "summary": "Get the local peer ID",
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    },
+                    "400": {
+                        "description": "Bad Request"
+                    },
+                    "404": {
+                        "description": "Not Found"
+                    },
+                    "500": {
+                        "description": "Internal Server Error"
+                    }
+                }
+            }
         }
     },
     "externalDocs": {
@@ -58,12 +84,12 @@ const docTemplate = `{
 
 // SwaggerInfo holds exported Swagger Info so clients can modify it
 var SwaggerInfo = &swag.Spec{
-	Version:          "1.0",
+	Version:          "0.0.1",
 	Host:             "localhost:8081",
 	BasePath:         "/api/v0",
 	Schemes:          []string{},
-	Title:            "Swagger Skypier API",
-	Description:      "This is a Skypier VPN REST API.",
+	Title:            "Skypier",
+	Description:      "Skypier - Embark securely on web3",
 	InfoInstanceName: "swagger",
 	SwaggerTemplate:  docTemplate,
 	LeftDelim:        "{{",

diff --git a/pkg/docs/swagger.json b/pkg/docs/swagger.json
@@ -1,18 +1,18 @@
 {
     "swagger": "2.0",
     "info": {
-        "description": "This is a Skypier VPN REST API.",
-        "title": "Swagger Skypier API",
+        "description": "Skypier - Embark securely on web3",
+        "title": "Skypier",
         "contact": {
-            "name": "Skypier info",
+            "name": "Skypier",
             "url": "http://skypier.io/",
             "email": "[email protected]"
         },
         "license": {
             "name": "MIT",
             "url": "https://choosealicense.com/licenses/mit/"
         },
-        "version": "1.0"
+        "version": "0.0.1"
     },
     "host": "localhost:8081",
     "basePath": "/api/v0",
@@ -42,6 +42,32 @@
                     }
                 }
             }
+        },
+        "/id": {
+            "get": {
+                "description": "Get the local libp2p peer ID (this is the identity of your node on the Skypier Network)",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "P2P"
+                ],
+                "summary": "Get the local peer ID",
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    },
+                    "400": {
+                        "description": "Bad Request"
+                    },
+                    "404": {
+                        "description": "Not Found"
+                    },
+                    "500": {
+                        "description": "Internal Server Error"
+                    }
+                }
+            }
         }
     },
     "externalDocs": {

diff --git a/pkg/docs/swagger.yaml b/pkg/docs/swagger.yaml
@@ -6,14 +6,14 @@ host: localhost:8081
 info:
   contact:
     email: [email protected]
-    name: Skypier info
+    name: Skypier
     url: http://skypier.io/
-  description: This is a Skypier VPN REST API.
+  description: Skypier - Embark securely on web3
   license:
     name: MIT
     url: https://choosealicense.com/licenses/mit/
-  title: Swagger Skypier API
-  version: "1.0"
+  title: Skypier
+  version: 0.0.1
 paths:
   /getConfig:
     get:
@@ -32,4 +32,22 @@ paths:
       summary: Get the configuration
       tags:
       - config
+  /id:
+    get:
+      description: Get the local libp2p peer ID (this is the identity of your node
+        on the Skypier Network)
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+        "400":
+          description: Bad Request
+        "404":
+          description: Not Found
+        "500":
+          description: Internal Server Error
+      summary: Get the local peer ID
+      tags:
+      - P2P
 swagger: "2.0"
diff --git a/pkg/vpn/p2p.go b/pkg/vpn/p2p.go
@@ -8,6 +8,7 @@ import (
 	b64 "encoding/base64"
 
 	"github.com/SkyPierIO/skypier-vpn/pkg/utils"
+	"github.com/gin-gonic/gin"
 	"github.com/ipfs/go-datastore"
 	"github.com/libp2p/go-libp2p"
 	dht "github.com/libp2p/go-libp2p-kad-dht"
@@ -55,6 +56,16 @@ func loadPrivateKey() (crypto.PrivKey, error) {
 	}
 }
 
+// GetPeerId     godoc
+// @Summary      Get the local peer ID
+// @Description  Get the local libp2p peer ID (this is the identity of your node on the Skypier Network)
+// @Tags         P2P
+// @Produce      json
+// @Router       /id [get]
+func GetPeerId(c *gin.Context) {
+	c.IndentedJSON(200, "Hello")
+}
+
 func displayNodeInfo(node host.Host, dht *dht.IpfsDHT) {
 	// print node ID
 	log.Println("───────────────────────────────────────────────────")

diff --git a/scripts/run.sh b/scripts/run.sh
@@ -0,0 +1,26 @@
+#!/bin/bash
+
+set -e
+
+pushd ./pkg
+echo -e "\n[+]\tGenerating swagger doc..."
+swag init --dir ../cmd/skypier-vpn-node/,../pkg/ui/,../pkg/vpn/,../pkg/utils/
+popd
+
+echo -e "\n[+]\tGo build..."
+go build -o build/skypier-vpn-node cmd/skypier-vpn-node/main.go
+echo -e "\n[+]\tRun..."
+sudo ./build/skypier-vpn-node
+
+
+
+
+
+
+
+
+
+
+
+
+