Sultan
/
Flowise
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Flowise/packages/api-documentation
History
Henry Heng d9a2c334a0
Feature/Update API Docs README (#3078) 
* Add interactive swagger-ui auto-generated API docs from express

* Update README.md

* Update index.ts //@ts-ignore

* Fix eslint no-console error

* Add swagger paths

* Add all end  points

* Update swagger.yml

* update swagger yml file

* update swagger config

* update swagger response indentation

* update api-docs README

* update README

---------

Co-authored-by: Octavian FlowiseAI <154992625+ocflowiseai@users.noreply.github.com>
 		2024-08-25 14:53:59 +01:00
..
src Feature/Update API Docs README (#3078) 2024-08-25 14:53:59 +01:00
README-ZH.md Feature/Update API Docs README (#3078) 2024-08-25 14:53:59 +01:00
README.md Feature/Update API Docs README (#3078) 2024-08-25 14:53:59 +01:00
nodemon.json Feature: interactive swagger-ui auto-generated API docs from express (#1812) 2024-08-25 13:22:07 +01:00
package.json Feature: interactive swagger-ui auto-generated API docs from express (#1812) 2024-08-25 13:22:07 +01:00
tsconfig.json Feature: interactive swagger-ui auto-generated API docs from express (#1812) 2024-08-25 13:22:07 +01:00

README.md

Flowise API Docs

English | 中文

A list of Flowise public APIs, allowing users to programmatically execute many of the same tasks as the same in the GUI.

To run this standalone:

  1. Spin up Flowise server: 
    cd Flowise
pnpm start
  2. Start API Docs server: 
    cd packages/api-documentation
pnpm start

To run in dev mode:

cd Flowise
pnpm dev

Docs will be served on: http://localhost:6655/api-docs

License

Source code in this repository is made available under the Apache License Version 2.0.