https://github.com/straydragon/dify-openapi
Dify API => OpenAPI Schema
https://github.com/straydragon/dify-openapi
dify openapi
Last synced: 12 months ago
JSON representation
Dify API => OpenAPI Schema
- Host: GitHub
- URL: https://github.com/straydragon/dify-openapi
- Owner: StrayDragon
- License: mit
- Created: 2025-02-22T12:20:00.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-02-26T09:43:22.000Z (12 months ago)
- Last Synced: 2025-02-26T10:19:24.460Z (12 months ago)
- Topics: dify, openapi
- Language: Python
- Homepage:
- Size: 414 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dify x OpenAPI
[](https://www.python.org)
[](https://github.com/astral-sh/ruff)
[](LICENSE)
[](https://github.com/astral-sh/uv)
[](https://codecov.io/gh/straydragon/dify-openapi)
[English](./doc/README.en.md) | 中文
提供 [Dify](https://github.com/langgenius/dify) API 的 OpenAPI Schema，可以使用 [OpenAPI UI](https://github.com/swagger-api/swagger-ui) 预览或使用 [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) 生成客户端
## Swagger UI 在线查看
- [知识库 - SwaggerUI](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/StrayDragon/dify-openapi/refs/heads/main/schema/datasets.zh.yaml)
- [聊天应用(聚合) - SwaggerUI](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/StrayDragon/dify-openapi/refs/heads/main/schema/app.zh.yaml)
## 接口列表
> [!tip]
> 这里指至少可以通过一次测试用例请求, 如果你发现有哪些API错误, 欢迎提issue或者pr!
- 知识库: [OpenAPI Schema(中文)](./schema/datasets.zh.yaml) | [OpenAPI Schema(English)](./schema/datasets.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/0.15.3/web/app/(commonLayout)/datasets/template)
- [x] POST /datasets - 创建空知识库
- [x] GET /datasets/{dataset_id}/documents - 获取文档列表
- [x] DELETE /datasets/{dataset_id}/documents/{document_id} - 删除文档
- [x] POST /datasets/{dataset_id}/document/create-by-text - 通过文本创建文档
- [x] POST /datasets/{dataset_id}/document/create-by-file - 通过文件创建文档
- [x] PUT /datasets/{dataset_id}/documents/{document_id} - 更新文档
- [x] POST /datasets/{dataset_id}/documents/{document_id}/update-by-file - 通过文件更新文档
- [x] GET /datasets/{dataset_id}/documents/{document_id}/upload-file - 获取上传文件
- [x] GET /datasets/{dataset_id}/documents/{batch}/indexing-status - 获取文档嵌入状态
- [x] GET /datasets/{dataset_id}/documents/{document_id}/segments - 查询文档分段
- [x] POST /datasets/{dataset_id}/documents/{document_id}/segments - 创建文档分段
- [x] DELETE /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id} - 删除文档分段
- [x] POST /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id} - 更新文档分段
- 聊天应用(聚合): [OpenAPI Schema(中文)](./schema/app.zh.yaml) | [OpenAPI Schema(English)](./schema/app.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/0.15.3/web/app/components/develop/template)
- [x] POST /completion-messages - 发送消息(文本生成型应用)
- [x] POST /chat-messages - 发送对话消息(对话型应用)
- [x] POST /workflows/run - 执行工作流(工作流应用)
- [x] POST /files/upload - 上传文件
- [x] POST /messages/{message_id}/feedbacks - 消息反馈
- [x] POST /conversations/{conversation_id}/name - 会话重命名
- [x] DELETE /conversations/{conversation_id} - 删除会话
- [x] GET /messages - 获取会话历史消息
- [x] GET /info - 获取应用基本信息
- [x] GET /parameters - 获取应用参数
- [ ] POST /audio-to-text - 语音转文字
- [ ] POST /text-to-audio - 文字转语音
## 项目结构
```
.
├── schema/ # OpenAPI schema
│ ├── app.zh.yaml # 应用 API
│ └── datasets.zh.yaml # 知识库 API
├── src/ # 生成的客户端代码
├── tests/ # 通过测试客户端代码, 校验 schema/* 是否正确
└── configs/ # 代码生成器配置
```
## 贡献 & 本地开发
安装这些工具：
- [uv](https://github.com/astral-sh/uv) - Python 包管理器
- [just](https://github.com/casey/just) - 替代 `Makefile`
- [ruff](https://github.com/astral-sh/ruff) - Python 代码格式化和检查工具
### 开发流程
#### 维护单元测试
1. 安装依赖：
```bash
uv venv && uv pip install -e ".[dev]"
```
2. 生成客户端代码：
```bash
just gen-client
```
3. 预览 API 文档：
```bash
just run-openapi-ui
```
4. 编辑环境变量：
```
cp .env.example .env
# 填写相关的变量
```
5. 运行测试：
```bash
just test
```
6. 提交 PR
#### 维护多语言支持
1. 新增/修改语言的 overlay 文件, 例如 `./schema/overlays/app.en.overlay.yaml`
2. 运行 `just apply-i18n-overlay-to-openapi-schema` 生成对应语言的schema (如果是新的语言, 请检查 [justfile](./justfile) 中是否处理了对应的名字)
3. 运行 `just run-openapi-ui` 预览 API 文档
4. 提交 PR