feat: add Swagger OpenAPI

.github/workflows/proxy_deployment.yaml

@@ -35,6 +35,7 @@ jobs:
       HF_TOKEN: ${{ secrets.HF_TOKEN }}
       SPACE_NAME: tebakaja_proxy_space-0
       HF_USERNAME: qywok
+      ENDPOINT: qywok-tebakaja-proxy-space-0.hf.space
 
     steps:
       - name: Set global directory
@@ -58,10 +59,16 @@ jobs:
           git pull https://$HF_USERNAME:[email protected]/spaces/$HF_USERNAME/$SPACE_NAME main || \
           (git merge --strategy-option theirs)
 
+      - name: Change Endpoint
+        run: |
+          sed -i "s/192.168.137.1:7860/$ENDPOINT/g" docs/docs.go
+          sed -i "s/192.168.137.1:7860/$ENDPOINT/g" docs/swagger.json
+          sed -i "s/192.168.137.1:7860/$ENDPOINT/g" docs/swagger.yaml
+
       - name: Add and commit changes
         run: |
           git add -A 
-          git diff-index --quiet HEAD || git commit -m "tebakaja_proxy_space-0"
+          git diff-index --quiet HEAD || git commit -m "$SPACE_NAME"
 
       - name: Push to Hugging Face
         run: |
@@ -78,6 +85,7 @@ jobs:
       HF_TOKEN: ${{ secrets.HF_TOKEN }}
       SPACE_NAME: tebakaja_proxy_space-1
       HF_USERNAME: qywok
+      ENDPOINT: qywok-tebakaja-proxy-space-1.hf.space
 
     steps:
       - name: Set global directory
@@ -101,10 +109,16 @@ jobs:
           git pull https://$HF_USERNAME:[email protected]/spaces/$HF_USERNAME/$SPACE_NAME main || \
           (git merge --strategy-option theirs)
 
+      - name: Change Endpoint
+        run: |
+          sed -i "s/192.168.137.1:7860/$ENDPOINT/g" docs/docs.go
+          sed -i "s/192.168.137.1:7860/$ENDPOINT/g" docs/swagger.json
+          sed -i "s/192.168.137.1:7860/$ENDPOINT/g" docs/swagger.yaml
+
       - name: Add and commit changes
         run: |
           git add -A 
-          git diff-index --quiet HEAD || git commit -m "tebakaja_proxy_space-1"
+          git diff-index --quiet HEAD || git commit -m "$SPACE_NAME"
 
       - name: Push to Hugging Face
         run: |
@@ -121,6 +135,7 @@ jobs:
       HF_TOKEN: ${{ secrets.HF_TOKEN }}
       SPACE_NAME: tebakaja_proxy_space-2
       HF_USERNAME: qywok
+      ENDPOINT: qywok-tebakaja-proxy-space-2.hf.space
 
     steps:
       - name: Set global directory
@@ -144,10 +159,16 @@ jobs:
           git pull https://$HF_USERNAME:[email protected]/spaces/$HF_USERNAME/$SPACE_NAME main || \
           (git merge --strategy-option theirs)
 
+      - name: Change Endpoint
+        run: |
+          sed -i "s/192.168.137.1:7860/$ENDPOINT/g" docs/docs.go
+          sed -i "s/192.168.137.1:7860/$ENDPOINT/g" docs/swagger.json
+          sed -i "s/192.168.137.1:7860/$ENDPOINT/g" docs/swagger.yaml
+
       - name: Add and commit changes
         run: |
           git add -A 
-          git diff-index --quiet HEAD || git commit -m "tebakaja_proxy_space-2"
+          git diff-index --quiet HEAD || git commit -m "$SPACE_NAME"
 
       - name: Push to Hugging Face
         run: |

Makefile

@@ -4,9 +4,13 @@ PROD_ENDPOINT_0=https://qywok-tebakaja-proxy-space-0.hf.space
 PROD_ENDPOINT_1=https://qywok-tebakaja-proxy-space-1.hf.space
 PROD_ENDPOINT_2=https://qywok-tebakaja-proxy-space-2.hf.space
 
-start:
+svc:
+	swag init
 	go run main.go
 
+swag:
+	swag init
+
 haproxy-test:
 	haproxy -f ./haproxy/haproxy.cfg
 
@@ -30,6 +34,9 @@ endpoints_check:
 #    --- Development Testing ---
 # 
 
+swag-test:
+	curl -X GET $(DEV_ENDPOINT)/swagger/index.html
+
 stock-list-test:
 	curl -X GET $(DEV_ENDPOINT)/stock/lists
 

docker-compose.yaml

@@ -4,6 +4,11 @@ services:
   proxy:
     build:
       context: .
+      shm_size : 536870912
       dockerfile: Dockerfile
+      labels :
+        role : "proxy service"
+
     ports:
       - "7860:7860"
+