mirror of
https://github.com/farcasclaudiu/Flowise.git
synced 2026-06-22 09:01:09 +03:00
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>
This commit is contained in:
@@ -0,0 +1,33 @@
|
||||
<!-- markdownlint-disable MD030 -->
|
||||
|
||||
# Flowise API 文档
|
||||
|
||||
[English](./README.md) | 中文
|
||||
|
||||
这是 Flowise 公共 API 的列表,允许用户以编程方式执行与 GUI 中相同的许多任务。
|
||||
|
||||
独立运行:
|
||||
|
||||
1. 启动 Flowise 服务器:
|
||||
```sh
|
||||
cd Flowise
|
||||
pnpm start
|
||||
```
|
||||
2. 启动 API 文档服务器:
|
||||
```sh
|
||||
cd packages/api-documentation
|
||||
pnpm start
|
||||
```
|
||||
|
||||
开发模式下运行:
|
||||
|
||||
```sh
|
||||
cd Flowise
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
文档将在此地址提供:http://localhost:6655/api-docs
|
||||
|
||||
## 许可证
|
||||
|
||||
此存储库中的源代码根据 Apache 2.0 许可证 提供
|
||||
@@ -0,0 +1,33 @@
|
||||
<!-- 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).
|
||||
@@ -280,17 +280,17 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Assistant'
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Assistant created successfully
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Assistant'
|
||||
'400':
|
||||
description: Invalid input provided
|
||||
'422':
|
||||
description: Validation exception
|
||||
responses:
|
||||
'200':
|
||||
description: Assistant created successfully
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Assistant'
|
||||
'400':
|
||||
description: Invalid input provided
|
||||
'422':
|
||||
description: Validation exception
|
||||
get:
|
||||
tags:
|
||||
- assistants
|
||||
|
||||
Reference in New Issue
Block a user