Update swagger workflow and add server urls (#187)

* Add documentation badge

* chore(swagger): automate swagger sync to amrit-docs

* chore(swagger): automate swagger sync to amrit-docs

* chore(swagger): automate swagger sync to amrit-docs

* chore(swagger): automate swagger sync to amrit-docs

* chore(swagger): update swagger workflow

* chore(swagger): add env-driven Dev/UAT/Demo servers and update swagger workflow

* chore(swagger): add version for swagger doc

Author: DurgaPrasad-54

.github/workflows/swagger-json.yml

@@ -97,7 +97,7 @@ jobs:
         with:
           token: ${{ secrets.DOCS_REPO_TOKEN }}
           path: amrit-docs
-          branch: auto/swagger-update-${{ github.run_id }}-${{ github.run_attempt }}
+          branch: auto/swagger-update-hwc-api
           base: main
           commit-message: "chore(docs): auto-update HWC-API swagger"
           title: "chore(docs): auto-update HWC-API swagger"

src/main/java/com/iemr/hwc/config/SwaggerConfig.java

@@ -2,6 +2,8 @@
 
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.core.env.Environment;
+import org.springframework.beans.factory.annotation.Value;
 
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
@@ -11,14 +13,25 @@
 
 @Configuration
 public class SwaggerConfig {
-	
-	@Bean
-    public OpenAPI customOpenAPI() {
-        return new OpenAPI().info(new 
-             Info().title("HWC API").version("version").description("A microservice for the creation and management of beneficiaries."))
-                .addSecurityItem(new SecurityRequirement().addList("my security"))
-                .components(new Components().addSecuritySchemes("my security",
-                        new SecurityScheme().name("my security").type(SecurityScheme.Type.HTTP).scheme("bearer")));
+    @Value("${api.version:1.0.0}")
+    private String apiVersion;
+    private static final String DEFAULT_SERVER_URL = "http://localhost:9090";
+
+    @Bean
+    public OpenAPI customOpenAPI(Environment env) {
+        String devUrl = env.getProperty("api.dev.url", DEFAULT_SERVER_URL);
+        String uatUrl = env.getProperty("api.uat.url", DEFAULT_SERVER_URL);
+        String demoUrl = env.getProperty("api.demo.url", DEFAULT_SERVER_URL);
+        return new OpenAPI()
+            .info(new Info().title("HWC API").version(apiVersion).description("A microservice for the creation and management of beneficiaries."))
+            .addSecurityItem(new SecurityRequirement().addList("my security"))
+            .components(new Components().addSecuritySchemes("my security",
+                new SecurityScheme().name("my security").type(SecurityScheme.Type.HTTP).scheme("bearer")))
+            .servers(java.util.Arrays.asList(
+                new io.swagger.v3.oas.models.servers.Server().url(devUrl).description("Dev"),
+                new io.swagger.v3.oas.models.servers.Server().url(uatUrl).description("UAT"),
+                new io.swagger.v3.oas.models.servers.Server().url(demoUrl).description("Demo")
+            ));
     }
 
 }

src/main/resources/application-swagger.properties

@@ -1,3 +1,7 @@
+# Swagger server URLs
+api.dev.url=${API_DEV_URL:https://amritwprdev.piramalswasthya.org}
+api.uat.url=${API_UAT_URL:https://uatamrit.piramalswasthya.org}
+api.demo.url=${API_DEMO_URL:https://amritdemo.piramalswasthya.org}
 registrationUrl=http://localhost:8080/registration
 syncSearchByLocation=http://localhost:8080/syncSearchByLocation
 getBenCountToSync=10