From 1a87a6d66335075190b4b10481861006a73b1db2 Mon Sep 17 00:00:00 2001 From: Robin Huang Date: Mon, 28 Apr 2025 13:29:45 -0700 Subject: [PATCH] Add instructions for staging development. (#14) --- comfy_api_nodes/README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/comfy_api_nodes/README.md b/comfy_api_nodes/README.md index 75b1d696a..86ba379f7 100644 --- a/comfy_api_nodes/README.md +++ b/comfy_api_nodes/README.md @@ -6,6 +6,18 @@ Below are a collection of nodes that work by calling external APIs. More informa ## Development +While developing, you should be testing against the Staging environment. To test against staging: + +**Install ComfyUI_frontend** + +Follow the instructions [here](https://github.com/Comfy-Org/ComfyUI_frontend) to start the frontend server. By default, it will connect to Staging authentication. + +> **Hint:** If you use --front-end-version argument for ComfyUI, it will use production authentication. + +```bash +python run main.py --comfy-api-base https://stagingapi.comfy.org +``` + API stubs are generated through automatic codegen tools from OpenAPI definitions. Since the Comfy Org OpenAPI definition contains many things from the Comfy Registry as well, we use redocly/cli to filter out only the paths relevant for API nodes. ### Redocly Instructions @@ -17,7 +29,7 @@ Before your API node PR merges, make sure to add the `Released` tag to the `open ```bash # Download the OpenAPI file from prod server. -curl -o openapi.yaml https://api.comfy.org/openapi +curl -o openapi.yaml https://stagingapi.comfy.org/openapi # Filter out unneeded API definitions. npm install -g @redocly/cli