72 lines
2.9 KiB
HTML
72 lines
2.9 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>FITRA - File transfer API</title>
|
|
<style>
|
|
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; max-width: 800px; margin: 0 auto; padding: 20px; line-height: 1.6; }
|
|
h1, h2 { color: #333; }
|
|
code { background: #f4f4f4; padding: 2px 6px; border-radius: 3px; font-family: 'Monaco', 'Consolas', monospace; }
|
|
pre { background: #f4f4f4; padding: 15px; border-radius: 5px; overflow-x: auto; }
|
|
.endpoint { margin: 20px 0; padding: 15px; border-left: 4px solid #007acc; background: #f9f9f9; }
|
|
.method { display: inline-block; padding: 3px 8px; border-radius: 3px; color: white; font-weight: bold; margin-right: 10px; }
|
|
.get { background: #61affe; }
|
|
.post { background: #49cc90; }
|
|
.step { margin: 10px 0; padding: 10px; background: #fff; border: 1px solid #ddd; border-radius: 3px; }
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<h1>🚀 FITRA - File transfer API</h1>
|
|
<p><strong>Version:</strong> 1.0.0</p>
|
|
<p>Simple file upload and download service for developers using HTTP requests in CLI.</p>
|
|
|
|
<h2>📋 API endpoints</h2>
|
|
|
|
<div class="endpoint">
|
|
<h3><span class="method post">POST</span>/upload</h3>
|
|
<p><strong>Description:</strong> Upload a file</p>
|
|
<p><strong>cURL Example:</strong></p>
|
|
<pre><code>curl -X POST -F "file=@/path/to/your/file.txt" {{.BaseURL}}/upload</code></pre>
|
|
</div>
|
|
|
|
<div class="endpoint">
|
|
<h3><span class="method get">GET</span>/uploads/{fileID}/{filename}</h3>
|
|
<p><strong>Description:</strong> Download a file using the ID and filename from upload response</p>
|
|
<p><strong>cURL Example:</strong></p>
|
|
<pre><code>curl -O {{.BaseURL}}/uploads/{fileID}/{filename}</code></pre>
|
|
</div>
|
|
|
|
<div class="endpoint">
|
|
<h3><span class="method get">GET</span>/health</h3>
|
|
<p><strong>Description:</strong> Check service health</p>
|
|
<p><strong>cURL Example:</strong></p>
|
|
<pre><code>curl {{.BaseURL}}/health</code></pre>
|
|
</div>
|
|
|
|
<h2>🔄 Usage</h2>
|
|
<div class="step">
|
|
<strong>Step 1:</strong> Upload a file using POST /upload with form-data 'file' parameter
|
|
</div>
|
|
<div class="step">
|
|
<strong>Step 2:</strong> Use the returned 'id' and 'filename' to construct download URL
|
|
</div>
|
|
<div class="step">
|
|
<strong>Step 3:</strong> Download the file using GET /uploads/{id}/{filename}
|
|
</div>
|
|
|
|
<h2>💡 Examples</h2>
|
|
<pre><code># 1. Upload a file
|
|
curl -X POST -F "file=@myfile.txt" {{.BaseURL}}/upload
|
|
|
|
# Response will include:
|
|
# {
|
|
# "id": "abc123...",
|
|
# "filename": "myfile.txt",
|
|
# "url": "{{.BaseURL}}/uploads/abc123.../myfile.txt"
|
|
# }
|
|
|
|
# 2. Download the file
|
|
curl -O {{.BaseURL}}/uploads/abc123.../myfile.txt</code></pre>
|
|
</body>
|
|
</html> |