fix

Author: juzhiyuan

.github/workflows/cicd.yaml

@@ -19,6 +19,7 @@ jobs:
       APISIX_ADMIN_API: "http://68.183.178.88:9180"
       # Demo admin key; replace if you change APISIX admin_key in config.
       APISIX_ADMIN_KEY: "edd1c9f034335f136f87ad84b625c8f1"
+      ADC_VERSION: "0.21.2"
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -29,17 +30,31 @@ jobs:
           echo "adc version (if present):" || true
           (adc --version || true)
 
-      - name: Install ADC (example, adjust as needed)
+      - name: Install ADC CLI
         run: |
-          echo "Install ADC here (adjust to your environment)."
-          echo "Example: download ADC 0.21.2 binary and add to PATH."
-          echo "Ensure 'adc' is available in PATH afterward."
+          set -euxo pipefail
+          arch="$(uname -m)"
+          case "${arch}" in
+            x86_64|amd64) adc_arch="amd64" ;;
+            arm64|aarch64) adc_arch="arm64" ;;
+            *)
+              echo "Unsupported architecture: ${arch}" >&2
+              exit 1
+              ;;
+          esac
+          url="https://github.com/api7/adc/releases/download/v${ADC_VERSION}/adc_${ADC_VERSION}_linux_${adc_arch}.tar.gz"
+          curl -sSL -o adc.tar.gz "${url}"
+          tar -xzf adc.tar.gz
+          install_dir="${HOME}/.local/bin"
+          mkdir -p "${install_dir}"
+          install -m 0755 adc "${install_dir}/adc"
+          echo "${install_dir}" >> "${GITHUB_PATH}"
+          adc --version
 
       - name: Render OpenAPI -> APISIX config
         id: render
         run: |
           bash scripts/adc_render.sh
-        continue-on-error: true
 
       - name: Upload rendered artifact (if any)
         if: always()

.gitignore

@@ -0,0 +1,2 @@
+dist/
+.DS_Store

README.md

@@ -27,12 +27,13 @@ Prerequisites: Docker 20+, Docker Compose, curl.
 
 When ADC CLI is ready, use `make render` to produce APISIX config and `make publish` to deploy it (see below).
 
-## OpenAPI + APISIX/ADC annotations
+## OpenAPI + ADC annotations
 
 - See `openapi/httpbin.yaml`, including `/get`, `/status/{code}`, `/anything`.
-- `x-apisix-*` per operation guides ADC resource generation:
-  - `x-apisix-upstream`: upstream nodes (`httpbin:8080`)
-  - `x-apisix-plugins`: enable plugins (e.g., `cors`, `proxy-rewrite`)
+- The first `servers` entry defines upstream nodes (`httpbin:8080` for local compose).
+- `x-adc-*` per operation guides ADC resource generation:
+  - `x-adc-name`: route name override (`httpbin_get`, etc.)
+  - `x-adc-plugins`: enable plugins (e.g., `cors`)
 
 ## Use ADC (Local)
 
@@ -45,14 +46,14 @@ When ADC CLI is ready, use `make render` to produce APISIX config and `make publ
 
 Notes:
 - This repo assumes `adc` is available in PATH.
-- ADC verbs vary by version. Scripts attempt common ones and will guide you if adjustment is needed. For ADC 0.21.2, there is no `render` command; `scripts/adc_render.sh` tries `openapi generate`, `generate`, then `compile`.
+- ADC verbs vary by version. Scripts attempt common ones and will guide you if adjustment is needed. For ADC 0.21.2, the script first tries `adc convert openapi`; if unavailable it falls back to historical verbs (`adc openapi generate`, `adc generate`, `adc render`, `adc compile`).
 
 ## GitHub Actions (CI/CD)
 
 - Workflow: `.github/workflows/cicd.yaml`
 - Triggers: push to `main` or PR
 - Steps:
-  - Install/prepare ADC (adjust to your environment)
+  - Install ADC CLI (GitHub Actions downloads v0.21.2 release binary)
   - Validate and render OpenAPI → APISIX config
   - Publish to APISIX Admin API
 Environment in workflow (demo only):
@@ -65,16 +66,14 @@ Environment in workflow (demo only):
 
 If outbound network is allowed and you prefer public `httpbin.org`:
 
-1. Edit `openapi/httpbin.yaml`, set `x-apisix-upstream` to:
-   - `nodes: { "httpbin.org:443": 1 }`
-   - `scheme: https`
-   - Optionally add `proxy-rewrite` with `host: httpbin.org`
-2. Re-run `make render` and publish.
+1. Edit `openapi/httpbin.yaml`, update the first `servers` entry to `https://httpbin.org` (or your upstream).
+2. Add/adjust `x-adc-plugins` as needed (e.g., `proxy-rewrite` to set `host: httpbin.org`).
+3. Re-run `make render` and publish.
 
 ## APISIX/etcd Configuration
 
 - `docker-compose.yml` runs `etcd`, `apisix`, `httpbin` containers (no persistent volumes)
-- APISIX config: provided inline via `APISIX_CONFIG_YAML` in Compose (file `apisix/conf/config.yaml` is included as a reference, not mounted)
+- APISIX config: stored in `apisix/conf/config.yaml` and mounted read-only into the APISIX container via Compose
   - etcd: `http://etcd:2379`
   - Admin API: `9180`
   - Gateway ports: `9080` (HTTP), `9443` (HTTPS)
@@ -99,8 +98,8 @@ If outbound network is allowed and you prefer public `httpbin.org`:
 ## Layout
 
 - `docker-compose.yml`: containers orchestration
-- `apisix/conf/config.yaml`: Reference APISIX config (Compose uses inline APISIX_CONFIG_YAML)
-- `openapi/httpbin.yaml`: OpenAPI with x-apisix hints for ADC
+- `apisix/conf/config.yaml`: APISIX config mounted by Compose
+- `openapi/httpbin.yaml`: OpenAPI with x-adc hints for ADC
 - `scripts/adc_render.sh`: ADC render script (auto-detect verbs)
 - `scripts/adc_publish.sh`: ADC publish/apply/sync script (auto-detect verbs)
 - `scripts/bootstrap_routes_via_admin.sh`: seed APISIX resources via Admin API

openapi/httpbin.yaml

@@ -2,33 +2,32 @@ openapi: 3.0.3
 info:
   title: Httpbin via APISIX
   description: |
-    Demonstration of routing httpbin through APISIX. Includes x-apisix extensions for ADC to generate APISIX resources.
+    Demonstration of routing httpbin through APISIX. Includes x-adc extensions for ADC to generate APISIX resources.
   version: 1.0.0
 servers:
-  - url: http://localhost:9080
-    description: Local APISIX Gateway
+  - url: http://httpbin:8080
+    description: Local httpbin upstream (ADC uses the first server entry to build upstream nodes)
 
 paths:
   /get:
     get:
       summary: Proxy to httpbin GET
       description: Returns request info from httpbin
       tags: [httpbin]
+      x-adc-name: httpbin_get
+      x-adc-plugins:
+        cors: {}
       responses:
         '200':
           description: OK
-      x-apisix-plugins:
-        cors: {}
-      x-apisix-upstream:
-        type: roundrobin
-        scheme: http
-        nodes:
-          "httpbin:8080": 1
 
   /status/{code}:
     get:
       summary: Return specific HTTP status code
       tags: [httpbin]
+      x-adc-name: httpbin_status
+      x-adc-plugins:
+        cors: {}
       parameters:
         - in: path
           name: code
@@ -40,18 +39,14 @@ paths:
       responses:
         '200':
           description: Example response (status code depends on path parameter)
-      x-apisix-plugins:
-        cors: {}
-      x-apisix-upstream:
-        type: roundrobin
-        scheme: http
-        nodes:
-          "httpbin:8080": 1
 
   /anything:
     post:
       summary: Echo any request data
       tags: [httpbin]
+      x-adc-name: httpbin_anything
+      x-adc-plugins:
+        cors: {}
       requestBody:
         required: false
         content:
@@ -64,12 +59,5 @@ paths:
       responses:
         '200':
           description: OK
-      x-apisix-plugins:
-        cors: {}
-      x-apisix-upstream:
-        type: roundrobin
-        scheme: http
-        nodes:
-          "httpbin:8080": 1
 
 components: {}

scripts/adc_publish.sh

@@ -22,6 +22,11 @@ if ! command -v adc >/dev/null 2>&1; then
   exec bash "${ROOT_DIR}/scripts/bootstrap_routes_via_admin.sh"
 fi
 
+if [ ! -f "${INPUT_FILE}" ]; then
+  echo "[ERROR] Config file not found: ${INPUT_FILE}. Run scripts/adc_render.sh first." 1>&2
+  exit 3
+fi
+
 echo "Using ADC: $(adc --version 2>/dev/null || echo unknown)"
 
 try_publish() {

scripts/adc_render.sh

@@ -4,9 +4,11 @@ set -euo pipefail
 # Render APISIX config from OpenAPI using ADC CLI (v0.21.2 supported)
 # This script tries multiple subcommands as ADC changed verbs across versions.
 # Priority (auto-detected):
-#   1) adc openapi generate -i <in> -o <out>
-#   2) adc generate -i <in> -o <out>
-#   3) adc compile -i <in> -o <out>
+#   1) adc convert openapi -f <in> -o <out>
+#   2) adc openapi generate -i <in> -o <out>
+#   3) adc generate -i <in> -o <out>
+#   4) adc render -i <in> -o <out>
+#   5) adc compile -i <in> -o <out>
 # If none are available, exits with guidance.
 
 ROOT_DIR="$(cd "$(dirname "$0")/.." && pwd)"
@@ -26,7 +28,7 @@ echo "Using ADC: $(adc --version 2>/dev/null || echo unknown)"
 echo "Input OpenAPI: ${INPUT_OPENAPI}"
 echo "Output: ${OUT_FILE}"
 
-run_with() {
+run_with_io_flags() {
   echo "Trying: adc $*"
   set +e
   adc "$@" -i "${INPUT_OPENAPI}" -o "${OUT_FILE}"
@@ -35,19 +37,34 @@ run_with() {
   return $rc
 }
 
+run_convert_openapi() {
+  echo "Trying: adc convert openapi"
+  set +e
+  adc convert openapi -f "${INPUT_OPENAPI}" -o "${OUT_FILE}"
+  rc=$?
+  set -e
+  return $rc
+}
+
 # Try known commands in order
-if run_with openapi generate; then
-  echo "Render OK -> ${OUT_FILE}"
-  exit 0
-elif run_with generate; then
-  echo "Render OK -> ${OUT_FILE}"
-  exit 0
-elif run_with compile; then
+if run_convert_openapi; then
   echo "Render OK -> ${OUT_FILE}"
   exit 0
 fi
 
-echo "[ERROR] Failed to render with known ADC commands (openapi generate / generate / compile)." 1>&2
+for cmd in \
+  "openapi generate" \
+  "generate" \
+  "render" \
+  "compile"
+do
+  if run_with_io_flags ${cmd}; then
+    echo "Render OK -> ${OUT_FILE}"
+    exit 0
+  fi
+done
+
+echo "[ERROR] Failed to render with known ADC commands (convert openapi / openapi generate / generate / render / compile)." 1>&2
 echo "        Your ADC (v0.21.2 reported) may use a different verb." 1>&2
 echo "        Please adjust this script to the correct ADC command." 1>&2
 exit 2