Add configurable OpenAPI server URL

docs: use https for OpenAPI base URL

.github/workflows/deploy-docs.yml

@@ -1,7 +1,11 @@
 name: Deploy Documentation
 
 on:
-  push:
+  workflow_call:
+    inputs:
+      build-id:
+        required: false
+        type: string
   workflow_dispatch:
 
 permissions:
@@ -16,6 +20,9 @@ jobs:
         with:
           fetch-depth: 1
 
+      - name: Log build
+        run: echo "Running documentation deployment from build ${{ inputs.build-id }}"
+
       - name: Setup Bun
         uses: oven-sh/setup-bun@v1
         with:

.github/workflows/deploy-staging.yml

@@ -5,6 +5,9 @@ on:
     branches: [main]
   workflow_dispatch:
 
+permissions:
+  contents: write
+
 jobs:
   build-and-deploy:
     runs-on: ubuntu-latest
@@ -21,3 +24,11 @@ jobs:
           key: ${{ secrets.SSH_KEY }}
           script: bash /opt/openisle/deploy-staging.sh
 
+  deploy-docs:
+    needs: build-and-deploy
+    if: ${{ success() }}
+    uses: ./.github/workflows/deploy-docs.yml
+    secrets: inherit
+    with:
+      build-id: ${{ github.run_id }}
+

CONTRIBUTING.md

@@ -246,3 +246,9 @@ https://resend.com/emails 创建账号并登录
   `RESEND_FROM_EMAIL`： **noreply@域名**
   `RESEND_API_KEY`：**刚刚复制的 Key**
   ![image-20250906151218330](assets/contributing/image-20250906151218330.png)
+
+## 开源共建和API文档
+
+- API文档: https://openisle-docs.netlify.app/docs/openapi
+
+

backend/src/main/java/com/openisle/config/OpenApiConfig.java

@@ -5,6 +5,9 @@ import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Info;
 import io.swagger.v3.oas.models.security.SecurityRequirement;
 import io.swagger.v3.oas.models.security.SecurityScheme;
+import io.swagger.v3.oas.models.servers.Server;
+
+import java.util.List;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -27,6 +30,9 @@ public class OpenApiConfig {
     @Value("${springdoc.info.header}")
     private String header;
 
+    @Value("${springdoc.api-docs.server-url}")
+    private String serverUrl;
+
     @Bean
     public OpenAPI openAPI() {
         SecurityScheme securityScheme = new SecurityScheme()
@@ -37,12 +43,12 @@ public class OpenApiConfig {
 			.name(header);
 
         return new OpenAPI()
+                .servers(List.of(new Server().url(serverUrl)))
                 .info(new Info()
-					.title(title)
+                        .title(title)
-					.description(description)
+                        .description(description)
-					.version(version))
+                        .version(version))
-                .components(new Components()
+                .components(new Components().addSecuritySchemes("JWT", securityScheme))
-					.addSecuritySchemes("JWT", securityScheme))
                 .addSecurityItem(new SecurityRequirement().addList("JWT"));
     }
 }

backend/src/main/resources/application.properties

@@ -108,6 +108,7 @@ rabbitmq.sharding.enabled=true
 # see https://springdoc.org/#springdoc-openapi-core-properties
 springdoc.api-docs.path=/api/v3/api-docs
 springdoc.api-docs.enabled=true
+springdoc.api-docs.server-url=${WEBSITE_URL:https://www.open-isle.com}
 springdoc.info.title=OpenIsle
 springdoc.info.description=OpenIsle Open API Documentation
 springdoc.info.version=0.0.1