mirror of
https://github.com/open-webui/openapi-servers
synced 2025-06-26 18:17:04 +00:00
doc: readme
This commit is contained in:
parent
be711eab13
commit
97e26fe94c
21
servers/filesystem/README.md
Normal file
21
servers/filesystem/README.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
# 🗂️ Filesystem Tool Server
|
||||||
|
|
||||||
|
A FastAPI-powered server to interact with your filesystem via OpenAPI.
|
||||||
|
|
||||||
|
## 🚀 Quickstart
|
||||||
|
|
||||||
|
Clone the repo and run the server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/open-webui/openapi-servers
|
||||||
|
cd openapi-servers/servers/filesystem
|
||||||
|
pip install -r requirements.txt
|
||||||
|
uvicorn main:app --host 0.0.0.0 --reload
|
||||||
|
```
|
||||||
|
|
||||||
|
📡 Your Filesystem server will be live at:
|
||||||
|
http://localhost:8000/docs
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Built for plug & play ⚡
|
@ -1 +1,17 @@
|
|||||||
Untested MCP Port, Contribution Welcome.
|
# 🧰 Git Tool Server
|
||||||
|
|
||||||
|
⚡️ A FastAPI-based Git tool server implementation.
|
||||||
|
|
||||||
|
> 🚧 Untested MCP Port – Contribution Welcome!
|
||||||
|
|
||||||
|
## 🚀 Quickstart
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/open-webui/openapi-servers
|
||||||
|
cd openapi-servers/servers/git
|
||||||
|
|
||||||
|
pip install -r requirements.txt
|
||||||
|
uvicorn main:app --host 0.0.0.0 --reload
|
||||||
|
```
|
||||||
|
|
||||||
|
✅ You're now running the Git tool server!
|
16
servers/memory/README.md
Normal file
16
servers/memory/README.md
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
# 🧠 Memory Tool Server
|
||||||
|
|
||||||
|
A plug-and-play server for memory tools using FastAPI.
|
||||||
|
|
||||||
|
## 🚀 Quickstart
|
||||||
|
|
||||||
|
Clone the repo and start the memory server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/open-webui/openapi-servers
|
||||||
|
cd openapi-servers/servers/memory
|
||||||
|
pip install -r requirements.txt
|
||||||
|
uvicorn main:app --host 0.0.0.0 --reload
|
||||||
|
```
|
||||||
|
|
||||||
|
That's it – you're live! 🟢
|
14
servers/time/README.md
Normal file
14
servers/time/README.md
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
# 🕒 Time Tool Server
|
||||||
|
|
||||||
|
Blazingly fast time API server ⚡️
|
||||||
|
|
||||||
|
## 🚀 Quickstart
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/open-webui/openapi-servers
|
||||||
|
cd openapi-servers/servers/time
|
||||||
|
pip install -r requirements.txt
|
||||||
|
uvicorn main:app --host 0.0.0.0 --reload
|
||||||
|
```
|
||||||
|
|
||||||
|
You're live. ⏱️📡
|
55
servers/weather/README.md
Normal file
55
servers/weather/README.md
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
# ⛅ Weather Tool Server
|
||||||
|
|
||||||
|
A sleek and simple FastAPI-based server to provide weather data using OpenAPI standards.
|
||||||
|
|
||||||
|
📦 Built with:
|
||||||
|
⚡️ FastAPI • 📜 OpenAPI • 🧰 Python
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 Quickstart
|
||||||
|
|
||||||
|
Clone the repo and get started in seconds:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/open-webui/openapi-servers
|
||||||
|
cd openapi-servers/servers/weather
|
||||||
|
|
||||||
|
# Install dependencies
|
||||||
|
pip install -r requirements.txt
|
||||||
|
|
||||||
|
# Run the server
|
||||||
|
uvicorn main:app --host 0.0.0.0 --reload
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔍 About
|
||||||
|
|
||||||
|
This server is part of the OpenAPI Tools Collection. Use it to fetch real-time weather information, location-based forecasts, and more — all wrapped in a developer-friendly OpenAPI interface.
|
||||||
|
|
||||||
|
Compatible with any OpenAPI-supported ecosystem, including:
|
||||||
|
|
||||||
|
- 🌀 FastAPI
|
||||||
|
- 📘 Swagger UI
|
||||||
|
- 🧪 API testing tools
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚧 Customization
|
||||||
|
|
||||||
|
Plug in your favorite weather provider API, tailor endpoints, or extend the OpenAPI spec. Ideal for integration into AI agents, automated dashboards, or personal assistants.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🌐 API Documentation
|
||||||
|
|
||||||
|
Once running, explore auto-generated interactive docs:
|
||||||
|
|
||||||
|
🖥️ Swagger UI: http://localhost:8000/docs
|
||||||
|
📄 OpenAPI JSON: http://localhost:8000/openapi.json
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Made with ❤️ by the Open WebUI community 🌍
|
||||||
|
Explore more tools ➡️ https://github.com/open-webui/openapi-servers
|
Loading…
Reference in New Issue
Block a user