Files
Flowise/packages/api-documentation/README.md
T
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

34 lines
681 B
Markdown

<!-- markdownlint-disable MD030 -->
# Flowise API Docs
English | [中文](./README-ZH.md)
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:
```sh
cd Flowise
pnpm start
```
2. Start API Docs server:
```sh
cd packages/api-documentation
pnpm start
```
To run in dev mode:
```sh
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](https://github.com/FlowiseAI/Flowise/blob/master/LICENSE.md).