From b6ac3f022a16ad6bbc6f04c8684f01ee49656e4b Mon Sep 17 00:00:00 2001 From: let5sne Date: Fri, 28 Nov 2025 18:04:26 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=81=20=E9=87=8D=E7=BB=84=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E7=9B=AE=E5=BD=95=E7=BB=93=E6=9E=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 变更： - 创建 docs/ 目录统一管理所有文档 - 移动所有 API 文档到 docs/ 目录 - API_DOCS_INDEX.md - RESTFUL_API_DOCUMENTATION.md - API_SERVICE_README.md - API_CLIENT_EXAMPLES.md - API_SERVICE_GUIDE.md - BRANCH_README.md - openapi.yaml - IOPaint_API.postman_collection.json - UPGRADE_NOTES.md - 更新所有文档间的引用路径 - 更新 README.md 中的文档链接 - 创建 docs/README.md 作为文档入口 优势： ✅ 清晰的目录结构 ✅ 文档集中管理 ✅ 易于查找和维护 ✅ 符合项目规范 🔧 Generated with Claude Code --- .github/API_BRANCH_MANIFEST.md | 16 ++-- README.md | 10 +-- .../API_CLIENT_EXAMPLES.md | 0 API_DOCS_INDEX.md => docs/API_DOCS_INDEX.md | 0 .../API_SERVICE_GUIDE.md | 0 .../API_SERVICE_README.md | 0 BRANCH_README.md => docs/BRANCH_README.md | 0 .../IOPaint_API.postman_collection.json | 0 docs/README.md | 77 +++++++++++++++++++ .../RESTFUL_API_DOCUMENTATION.md | 0 UPGRADE_NOTES.md => docs/UPGRADE_NOTES.md | 0 openapi.yaml => docs/openapi.yaml | 0 12 files changed, 90 insertions(+), 13 deletions(-) rename API_CLIENT_EXAMPLES.md => docs/API_CLIENT_EXAMPLES.md (100%) rename API_DOCS_INDEX.md => docs/API_DOCS_INDEX.md (100%) rename API_SERVICE_GUIDE.md => docs/API_SERVICE_GUIDE.md (100%) rename API_SERVICE_README.md => docs/API_SERVICE_README.md (100%) rename BRANCH_README.md => docs/BRANCH_README.md (100%) rename IOPaint_API.postman_collection.json => docs/IOPaint_API.postman_collection.json (100%) create mode 100644 docs/README.md rename RESTFUL_API_DOCUMENTATION.md => docs/RESTFUL_API_DOCUMENTATION.md (100%) rename UPGRADE_NOTES.md => docs/UPGRADE_NOTES.md (100%) rename openapi.yaml => docs/openapi.yaml (100%) diff --git a/.github/API_BRANCH_MANIFEST.md b/.github/API_BRANCH_MANIFEST.md index f36b541..3e67142 100644 --- a/.github/API_BRANCH_MANIFEST.md +++ b/.github/API_BRANCH_MANIFEST.md @@ -205,16 +205,16 @@ git commit -m "sync: 同步工具函数优化" ## 🚀 快速链接 ### 文档 -- [📑 文档导航](../API_DOCS_INDEX.md) -- [🚀 快速开始](../API_SERVICE_README.md) -- [📖 REST API 文档](../RESTFUL_API_DOCUMENTATION.md) -- [💻 客户端示例](../API_CLIENT_EXAMPLES.md) -- [🏗️ 部署方案](../API_SERVICE_GUIDE.md) -- [🌿 分支说明](../BRANCH_README.md) +- [📑 文档导航](./API_DOCS_INDEX.md) +- [🚀 快速开始](./API_SERVICE_README.md) +- [📖 REST API 文档](./RESTFUL_API_DOCUMENTATION.md) +- [💻 客户端示例](./API_CLIENT_EXAMPLES.md) +- [🏗️ 部署方案](./API_SERVICE_GUIDE.md) +- [🌿 分支说明](./BRANCH_README.md) ### 配置文件 -- [OpenAPI 规范](../openapi.yaml) -- [Postman Collection](../IOPaint_API.postman_collection.json) +- [OpenAPI 规范](./openapi.yaml) +- [Postman Collection](./IOPaint_API.postman_collection.json) - [Docker Compose](../docker-compose.mvp.yml) - [Nginx 配置](../nginx/nginx.conf) diff --git a/README.md b/README.md index e674f87..1a153f6 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,14 @@ > > This branch provides a **production-ready REST API service** for watermark removal and inpainting. > -> - 🚀 **Quick Start**: See [API_SERVICE_README.md](./API_SERVICE_README.md) -> - 📖 **API Documentation**: See [RESTFUL_API_DOCUMENTATION.md](./RESTFUL_API_DOCUMENTATION.md) -> - 🏗️ **Deployment Guide**: See [API_SERVICE_GUIDE.md](./API_SERVICE_GUIDE.md) -> - 📑 **All Docs**: See [API_DOCS_INDEX.md](./API_DOCS_INDEX.md) +> - 🚀 **Quick Start**: See [API_SERVICE_README.md](./docs/API_SERVICE_README.md) +> - 📖 **API Documentation**: See [RESTFUL_API_DOCUMENTATION.md](./docs/RESTFUL_API_DOCUMENTATION.md) +> - 🏗️ **Deployment Guide**: See [API_SERVICE_GUIDE.md](./docs/API_SERVICE_GUIDE.md) +> - 📑 **All Docs**: See [API_DOCS_INDEX.md](./docs/API_DOCS_INDEX.md) > > **Looking for the WebUI version?** Switch to [main branch](https://github.com/let5sne/IOPaint/tree/main) > -> **Branch Comparison**: See [BRANCH_README.md](./BRANCH_README.md) +> **Branch Comparison**: See [BRANCH_README.md](./docs/BRANCH_README.md)

diff --git a/API_CLIENT_EXAMPLES.md b/docs/API_CLIENT_EXAMPLES.md similarity index 100% rename from API_CLIENT_EXAMPLES.md rename to docs/API_CLIENT_EXAMPLES.md diff --git a/API_DOCS_INDEX.md b/docs/API_DOCS_INDEX.md similarity index 100% rename from API_DOCS_INDEX.md rename to docs/API_DOCS_INDEX.md diff --git a/API_SERVICE_GUIDE.md b/docs/API_SERVICE_GUIDE.md similarity index 100% rename from API_SERVICE_GUIDE.md rename to docs/API_SERVICE_GUIDE.md diff --git a/API_SERVICE_README.md b/docs/API_SERVICE_README.md similarity index 100% rename from API_SERVICE_README.md rename to docs/API_SERVICE_README.md diff --git a/BRANCH_README.md b/docs/BRANCH_README.md similarity index 100% rename from BRANCH_README.md rename to docs/BRANCH_README.md diff --git a/IOPaint_API.postman_collection.json b/docs/IOPaint_API.postman_collection.json similarity index 100% rename from IOPaint_API.postman_collection.json rename to docs/IOPaint_API.postman_collection.json diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..490f460 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,77 @@ +# IOPaint API Service Documentation + +Welcome to the IOPaint API Service documentation! This directory contains all the documentation for the API service branch. + +## 📑 Documentation Index + +### Quick Start +- **[API Service README](./API_SERVICE_README.md)** - 🚀 Get started in 10 minutes +- **[Documentation Index](./API_DOCS_INDEX.md)** - 📑 Complete navigation guide + +### API Reference +- **[RESTful API Documentation](./RESTFUL_API_DOCUMENTATION.md)** - 📖 Complete API reference (OpenAI style) +- **[OpenAPI Specification](./openapi.yaml)** - 🔧 OpenAPI 3.0.3 spec file +- **[Postman Collection](./IOPaint_API.postman_collection.json)** - 🧪 API testing collection + +### Integration & Examples +- **[Client Examples](./API_CLIENT_EXAMPLES.md)** - 💻 Multi-language code examples + - Python (Basic + Advanced) + - JavaScript/Node.js + - PHP + - Go + - Java + - cURL/Bash + +### Deployment & Architecture +- **[Service Guide](./API_SERVICE_GUIDE.md)** - 🏗️ MVP to production deployment guide + - Architecture design (Docker → Kubernetes) + - Cost analysis & revenue models + - Implementation roadmap + +### Branch Information +- **[Branch README](./BRANCH_README.md)** - 🌿 Branch comparison and switching guide +- **[Upgrade Notes](./UPGRADE_NOTES.md)** - 📝 Package upgrade history + +## 🎯 Choose Your Path + +### I want to... + +**...get started quickly** +→ Read [API_SERVICE_README.md](./API_SERVICE_README.md) + +**...integrate the API** +→ Read [RESTFUL_API_DOCUMENTATION.md](./RESTFUL_API_DOCUMENTATION.md) + [API_CLIENT_EXAMPLES.md](./API_CLIENT_EXAMPLES.md) + +**...test the API** +→ Import [IOPaint_API.postman_collection.json](./IOPaint_API.postman_collection.json) or visit http://localhost:8080/docs + +**...deploy for production** +→ Read [API_SERVICE_GUIDE.md](./API_SERVICE_GUIDE.md) + +**...understand branch differences** +→ Read [BRANCH_README.md](./BRANCH_README.md) + +## 📊 Documentation Stats + +| Type | Files | Pages | Languages | +|------|-------|-------|-----------| +| Core Docs | 6 | ~120 | - | +| Code Examples | 1 | ~28 | 6 | +| Spec Files | 2 | - | - | +| **Total** | **9** | **~150** | **6** | + +## 🔗 External Links + +- **Repository**: https://github.com/let5sne/IOPaint +- **API Branch**: https://github.com/let5sne/IOPaint/tree/feature/api-service +- **Main Branch**: https://github.com/let5sne/IOPaint/tree/main + +## 📞 Support + +- **GitHub Issues**: https://github.com/let5sne/IOPaint/issues +- **Documentation Feedback**: Open an issue with label `documentation` + +--- + +**Last Updated**: 2025-11-28 +**Version**: 1.0.0 diff --git a/RESTFUL_API_DOCUMENTATION.md b/docs/RESTFUL_API_DOCUMENTATION.md similarity index 100% rename from RESTFUL_API_DOCUMENTATION.md rename to docs/RESTFUL_API_DOCUMENTATION.md diff --git a/UPGRADE_NOTES.md b/docs/UPGRADE_NOTES.md similarity index 100% rename from UPGRADE_NOTES.md rename to docs/UPGRADE_NOTES.md diff --git a/openapi.yaml b/docs/openapi.yaml similarity index 100% rename from openapi.yaml rename to docs/openapi.yaml