ATAMS Documentation API

API sederhana untuk menyajikan dan menampilkan dokumentasi proyek ATAMS dalam format markdown.

Deskripsi

ATAMS Documentation API adalah aplikasi FastAPI yang mengindeks dan menyajikan file dokumentasi markdown dari folder Backend dan Frontend, dengan link langsung ke repository GitHub.

Fitur

• 📚 Mengindeks semua file .md dari folder Backend dan Frontend
• 🔗 Menyediakan link langsung ke GitHub untuk setiap dokumentasi
• 🌐 Interface web sederhana untuk browsing dokumentasi
• ⚡ Built with FastAPI untuk performa tinggi
• 📱 Responsive design

Struktur Folder

adocs/
├── Backend/           # Dokumentasi backend services
│   ├── atlas.md
│   ├── atabot.md
│   ├── atams.md
│   └── ...
├── Frontend/          # Dokumentasi frontend
│   └── test.md
├── main.py           # FastAPI application
├── index.html        # Frontend interface
└── README.md

Instalasi

1. Clone repository:

git clone https://github.com/GratiaManullang03/adocs-api.git
cd adocs

2. Buat virtual environment (opsional tapi direkomendasikan):

python -m venv venv
source venv/bin/activate  # Linux/Mac
# atau
venv\Scripts\activate     # Windows

3. Install dependencies:

pip install fastapi uvicorn

Menjalankan Aplikasi

Development Mode

uvicorn main:app --reload

Production Mode

python main.py

Aplikasi akan berjalan di http://localhost:8000

API Endpoints

GET /

Menampilkan halaman web interface

GET /adocs

Mendapatkan daftar semua file dokumentasi

Response:

{
  "success": true,
  "message": "Documentation files retrieved successfully",
  "total": 12,
  "data": [
    {
      "name": "Atlas",
      "filename": "Backend/atlas.md",
      "url": "https://github.com/atams/adocs-api/blob/main/Backend/atlas.md"
    },
    {
      "name": "Test",
      "filename": "Frontend/test.md",
      "url": "https://github.com/atams/adocs-api/blob/main/Frontend/test.md"
    }
  ]
}

Menambah Dokumentasi Baru

Untuk menambahkan dokumentasi baru:

1. Buat file .md baru di folder Backend/ atau Frontend/
2. File akan otomatis terdeteksi saat endpoint /adocs dipanggil
3. Format nama file: gunakan lowercase dengan dash untuk pemisah (contoh: my-service.md)

Teknologi yang Digunakan

• FastAPI - Modern web framework untuk Python
• Uvicorn - ASGI server
• Python 3.x - Programming language
• HTML/CSS/JavaScript - Frontend interface

Kontribusi

Untuk menambahkan atau mengubah dokumentasi:

1. Fork repository ini
2. Buat branch baru (git checkout -b feature/dokumentasi-baru)
3. Tambahkan file dokumentasi di folder yang sesuai
4. Commit changes (git commit -m 'Tambah dokumentasi baru')
5. Push ke branch (git push origin feature/dokumentasi-baru)
6. Buat Pull Request

Project Link: https://github.com/atams/adocs-api