Update Swagger documentation and add BasicAuth (#82)

### TL;DR

Updated API documentation and added basic authentication.

### What changed?

- Removed unnecessary contact information and terms of service from API documentation
- Added license information to Swagger documentation
- Updated host and base path in Swagger configuration
- Implemented basic authentication for API endpoints
- Updated Swagger info with version, title, and description

### How to test?

1. Run the API server
2. Access the Swagger documentation at `/swagger/index.html`
3. Verify that the updated information is displayed correctly
4. Test API endpoints using basic authentication

### Why make this change?

This change improves the API documentation by removing unnecessary information and adding important details like licensing. It also enhances security by implementing basic authentication for API endpoints, ensuring that only authorized users can access the API.

Author: Amine Afia

cmd/api.go

@@ -29,20 +29,12 @@ var (
 // @title Thirdweb Insight
 // @version v0.0.1-beta
 // @description API for querying blockchain transactions and events
-// @termsOfService http://swagger.io/terms/
-
-// @contact.name Thirdweb Support
-// @contact.url https://thirdweb.com/support
-// @contact.email [email protected]
-
 // @license.name Apache 2.0
 // @license.url https://github.com/thirdweb-dev/indexer/blob/main/LICENSE
-
 // @host localhost:3000
 // @BasePath /
-
+// @Security BasicAuth
 // @securityDefinitions.basic BasicAuth
-
 func RunApi(cmd *cobra.Command, args []string) {
 	r := gin.New()
 	r.Use(gin.Logger())

docs/docs.go

@@ -10,6 +10,10 @@ const docTemplate = `{
         "description": "{{escape .Description}}",
         "title": "{{.Title}}",
         "contact": {},
+        "license": {
+            "name": "Apache 2.0",
+            "url": "https://github.com/thirdweb-dev/indexer/blob/main/LICENSE"
+        },
         "version": "{{.Version}}"
     },
     "host": "{{.Host}}",
@@ -934,17 +938,27 @@ const docTemplate = `{
                 }
             }
         }
-    }
+    },
+    "securityDefinitions": {
+        "BasicAuth": {
+            "type": "basic"
+        }
+    },
+    "security": [
+        {
+            "BasicAuth": []
+        }
+    ]
 }`
 
 // SwaggerInfo holds exported Swagger Info so clients can modify it
 var SwaggerInfo = &swag.Spec{
-	Version:          "",
-	Host:             "",
-	BasePath:         "",
+	Version:          "v0.0.1-beta",
+	Host:             "localhost:3000",
+	BasePath:         "/",
 	Schemes:          []string{},
-	Title:            "",
-	Description:      "",
+	Title:            "Thirdweb Insight",
+	Description:      "API for querying blockchain transactions and events",
 	InfoInstanceName: "swagger",
 	SwaggerTemplate:  docTemplate,
 	LeftDelim:        "{{",

docs/swagger.json

@@ -1,8 +1,17 @@
 {
     "swagger": "2.0",
     "info": {
-        "contact": {}
+        "description": "API for querying blockchain transactions and events",
+        "title": "Thirdweb Insight",
+        "contact": {},
+        "license": {
+            "name": "Apache 2.0",
+            "url": "https://github.com/thirdweb-dev/indexer/blob/main/LICENSE"
+        },
+        "version": "v0.0.1-beta"
     },
+    "host": "localhost:3000",
+    "basePath": "/",
     "paths": {
         "/{chainId}/events": {
             "get": {
@@ -923,5 +932,15 @@
                 }
             }
         }
-    }
+    },
+    "securityDefinitions": {
+        "BasicAuth": {
+            "type": "basic"
+        }
+    },
+    "security": [
+        {
+            "BasicAuth": []
+        }
+    ]
 }

docs/swagger.yaml

@@ -1,3 +1,4 @@
+basePath: /
 definitions:
   api.Error:
     description: Error represents an API error response
@@ -120,8 +121,15 @@ definitions:
       value:
         type: string
     type: object
+host: localhost:3000
 info:
   contact: {}
+  description: API for querying blockchain transactions and events
+  license:
+    name: Apache 2.0
+    url: https://github.com/thirdweb-dev/indexer/blob/main/LICENSE
+  title: Thirdweb Insight
+  version: v0.0.1-beta
 paths:
   /{chainId}/events:
     get:
@@ -592,4 +600,9 @@ paths:
       summary: Get transactions by contract and signature
       tags:
       - transactions
+security:
+- BasicAuth: []
+securityDefinitions:
+  BasicAuth:
+    type: basic
 swagger: "2.0"