xinyun/ComfyUI
1
0
Fork 0
mirror of https://git.datalinker.icu/comfyanonymous/ComfyUI synced 2026-09-06 11:37:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add instructions for staging development. (#14)

Browse Source
This commit is contained in:
Robin Huang 2025-04-28 13:29:45 -07:00 committed by Jedrzej Kosinski
parent 04182a1592
commit 1a87a6d663
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
comfy_api_nodes/README.md
View File

@ -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