refactor: keep production url in swagger config

hiteshchoudhary · Oct 2, 2024 · a6a1017 · a6a1017
1 parent bfa8989
commit a6a1017
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -231,3 +231,5 @@ Click [here](https://github.com/hiteshchoudhary/apihub/blob/main/CONTRIBUTING_CO
 # 📜 Swagger Docs
 
 [Swagger Docs](https://api.freeapi.app): https://api.freeapi.app
+
+NOTE: Swagger docs are auto generated from the `swagger.yaml` file. While running the project locally, make sure you change the url to `http://localhost:<port_from_.env>/api/v1` in the swagger docs `servers/url` field.
diff --git a/src/swagger.yaml b/src/swagger.yaml
@@ -37,7 +37,7 @@ info:
   version: 1.3.1
   contact: {}
 servers:
-  - url: ${{server}}
+  - url: https://api.freeapi.app/api/v1 # add `http://localhost:<port_from_.env>/api/v1` in case of local testing
 paths:
   /public/randomusers:
     get:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -231,3 +231,5 @@ Click [here](https://github.com/hiteshchoudhary/apihub/blob/main/CONTRIBUTING_CO
		# 📜 Swagger Docs

		[Swagger Docs](https://api.freeapi.app): https://api.freeapi.app

		NOTE: Swagger docs are auto generated from the `swagger.yaml` file. While running the project locally, make sure you change the url to `http://localhost:<port_from_.env>/api/v1` in the swagger docs `servers/url` field.