From 99f24d417729a47406f51bf5f1b267b8e29ec1e3 Mon Sep 17 00:00:00 2001
From: Amine Afia <amine@thirdweb.com>
Date: Thu, 3 Oct 2024 20:08:48 +0200
Subject: [PATCH] Add Swagger JSON endpoint (#87)

### TL;DR

Added a new endpoint to serve Swagger JSON file.

### What changed?

- Introduced a new GET route `/json` in the API.
- This route serves the `swagger.json` file located in the `./docs` directory.

### How to test?

1. Start the API server.
2. Make a GET request to `http://your-api-host/json`.
3. Verify that the response is the contents of the `swagger.json` file.

### Why make this change?

This change allows direct access to the Swagger JSON file, which can be useful for:
- Integrating with external tools that consume Swagger/OpenAPI specifications.
- Enabling developers to easily download and use the API documentation offline.
- Facilitating automated testing or documentation generation processes that require the raw Swagger JSON.
---
 cmd/api.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/cmd/api.go b/cmd/api.go
index 99f5631..1550758 100644
--- a/cmd/api.go
+++ b/cmd/api.go
@@ -42,6 +42,10 @@ func RunApi(cmd *cobra.Command, args []string) {
 
 	// Add Swagger route
 	r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
+	// Add Swagger JSON endpoint
+	r.GET("/json", func(c *gin.Context) {
+		c.File("./docs/swagger.json")
+	})
 
 	root := r.Group("/:chainId")
 	{