Dokumentasi API dengan Swagger - Revision history

Onnowpurbo at 01:09, 8 April 2025

2025-04-08T01:09:44Z

Onnowpurbo at 12:17, 7 April 2025

2025-04-07T12:17:50Z

Show changes

Onnowpurbo at 03:25, 6 April 2025

2025-04-06T03:25:55Z

Show changes

Onnowpurbo: Created page with "Berikut adalah struktur materi untuk kuliah "Pengenalan Deployment Aplikasi Web menggunakan Python" yang terdiri dari empat bagian utama, masing-masing dengan tiga modul: **1..."

2025-04-06T02:42:37Z

Created page with "Berikut adalah struktur materi untuk kuliah "Pengenalan Deployment Aplikasi Web menggunakan Python" yang terdiri dari empat bagian utama, masing-masing dengan tiga modul: **1..."

New page

Berikut adalah struktur materi untuk kuliah "Pengenalan Deployment Aplikasi Web menggunakan Python" yang terdiri dari empat bagian utama, masing-masing dengan tiga modul:

**1. Dasar-dasar Pengembangan Web Menggunakan Python**

- **1.1. Pengenalan Flask: Membuat Aplikasi Web Sederhana**
- Memahami konsep dasar Flask dan cara membuat aplikasi web sederhana.
- Contoh: Membuat halaman "Hello, World!" menggunakan Flask.
- Referensi: [Tutorial Flask oleh Miguel Grinberg](https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world)

- **1.2. Struktur Proyek Flask dan Manajemen Template**
- Mempelajari struktur proyek yang baik dalam Flask dan penggunaan template untuk memisahkan logika dan tampilan.
- Contoh: Menggunakan Jinja2 untuk membuat template dinamis.
- Referensi: [Tutorial Flask Resmi](https://flask.palletsprojects.com/en/stable/tutorial/)

- **1.3. Mengelola Basis Data dengan SQLAlchemy**
- Integrasi Flask dengan SQLAlchemy untuk operasi basis data.
- Contoh: Membuat model data dan melakukan operasi CRUD.
- Referensi: [Membangun Aplikasi Web dengan Flask](https://www.digitalocean.com/community/tutorials/how-to-make-a-web-application-using-flask-in-python-3)

**2. Dasar-dasar Komunikasi Backend pada Web Python**

- **2.1. Routing dan Metode HTTP dalam Flask**
- Memahami cara kerja routing dan berbagai metode HTTP (GET, POST, PUT, DELETE).
- Contoh: Membuat endpoint dengan berbagai metode HTTP.
- Referensi: [Tutorial Flask Resmi](https://flask.palletsprojects.com/en/stable/tutorial/)

- **2.2. Mengelola Formulir dan Validasi Input**
- Menggunakan Flask-WTF untuk mengelola formulir dan validasi input pengguna.
- Contoh: Membuat formulir login dengan validasi.
- Referensi: [Membangun Aplikasi Web dengan Flask](https://www.digitalocean.com/community/tutorials/how-to-make-a-web-application-using-flask-in-python-3)

- **2.3. Komunikasi Asinkron dengan JavaScript dan Flask**
- Mengintegrasikan Flask dengan JavaScript untuk komunikasi asinkron menggunakan AJAX.
- Contoh: Memuat data secara dinamis tanpa me-refresh halaman.
- Referensi: [Komunikasi Frontend dan Backend](https://www.reddit.com/r/learnprogramming/comments/8xdh5s/how_do_you_connect_the_frontend_and_backend/)

**3. Keamanan Aplikasi Web Python**

- **3.1. Manajemen Autentikasi dan Otorisasi**
- Implementasi sistem login dan kontrol akses pengguna.
- Contoh: Menggunakan Flask-Login untuk manajemen sesi pengguna.
- Referensi: [Tutorial Flask Resmi](https://flask.palletsprojects.com/en/stable/tutorial/)

- **3.2. Mencegah Serangan Umum pada Aplikasi Web**
- Memahami dan mencegah serangan seperti SQL Injection dan Cross-Site Scripting (XSS).
- Contoh: Menggunakan parameterized queries dan escaping output.
- Referensi: [Analisis Keamanan Aplikasi Web dengan Python](https://bytescout.com/blog/python-tutorial-web-app-security.html)

- **3.3. Mengamankan API dengan Tokenisasi**
- Menggunakan token untuk mengamankan komunikasi antara klien dan server.
- Contoh: Implementasi JSON Web Tokens (JWT) dalam Flask.
- Referensi: [Membuat REST API dengan Flask](https://www.digitalocean.com/community/tutorials/create-a-rest-api-using-flask-on-ubuntu)

**4. Membangun RESTful API Menggunakan Python**

- **4.1. Konsep Dasar RESTful API dan Implementasi dengan Flask**
- Memahami prinsip REST dan cara mengimplementasikannya menggunakan Flask.
- Contoh: Membuat endpoint RESTful untuk operasi CRUD.
- Referensi: [Membuat REST API dengan Flask](https://www.digitalocean.com/community/tutorials/create-a-rest-api-using-flask-on-ubuntu)

- **4.2. Dokumentasi API dengan Swagger**
- Menggunakan Flask-Swagger untuk mendokumentasikan API yang dibuat.
- Contoh: Menambahkan dokumentasi interaktif untuk endpoint yang tersedia.
- Referensi: [Tutorial Flask-Swagger](https://github.com/flasgger/flasgger)

- **4.3. Deployment Aplikasi Flask di Ubuntu 24.04**
- Langkah-langkah untuk mendeploy aplikasi Flask pada server Ubuntu 24.04 tanpa menggunakan alat dari Microsoft.
- Contoh: Menggunakan Gunicorn dan Nginx untuk menjalankan aplikasi di lingkungan produksi.
- Referensi: [Instalasi Flask di Ubuntu 24.04](https://support.hostinger.com/en/articles/10725412-how-to-install-flask-on-ubuntu-24-04)

Struktur ini dirancang untuk memberikan pemahaman komprehensif tentang pengembangan dan deployment aplikasi web menggunakan Python, dengan fokus pada praktik terbaik dan contoh nyata yang dapat diterapkan langsung.

@@ Line 1: / Line 1: @@
-Oke Dzaq! Di bawah ini adalah panduan lengkap untuk membuat **modul dokumentasi API dengan Swagger** di **Ubuntu 24.04**. Kita akan pakai **FastAPI + Swagger UI** karena simpel dan cocok buat dokumentasi REST API secara otomatis.
+Kita akan pakai '''FastAPI + Swagger UI''' karena simpel dan cocok buat dokumentasi REST API secara otomatis.
----
+==Install Python dan pip==
 Ubuntu 24.04 biasanya udah include Python 3. Tapi kita pastikan dulu:
-```bash
+ sudo apt update
-sudo apt update
+ sudo apt install python3 python3-pip -y
----
+==Buat Virtual Environment (opsional tapi disarankan)==
-## 📦 2. **Buat Virtual Environment (opsional tapi disarankan)**
+ sudo apt install python3-venv -y
-```bash
+==Install FastAPI dan Uvicorn==
----
+ pip install fastapi uvicorn
-## 🔧 3. **Install FastAPI dan Uvicorn**
+==Buat File Project: `main.py`==
-```bash
+ # main.py
-pip install fastapi uvicorn
-```
+ from fastapi import FastAPI
----
+==Jalankan API==
-## 📁 4. **Buat File Project: `main.py`**
+ uvicorn main:app --reload
-```python
+==Akses Swagger UI==
-from fastapi import FastAPI
+Setelah dijalankan, buka browser dan kunjungi:
-app = FastAPI(title="Swagger API - Metro TV", version="1.0")
+ http://127.0.0.1:8000/docs
-# Contoh Model
+Swagger UI akan otomatis tampil dan mendokumentasikan semua endpoint.
-# Route dasar
+==Akses Redoc (Alternatif UI)==
-# Route dengan parameter
+ http://127.0.0.1:8000/redoc
-# POST endpoint
+==Export Dokumentasi ke JSON atau YAML==
----
+Kalau kamu butuh file dokumentasi:
-```
+'''JSON:'''
----
+ http://127.0.0.1:8000/openapi.json
-## 🧾 8. **Export Dokumentasi ke JSON atau YAML**
+'''YAML (butuh converter, contoh pakai `json2yaml`):'''
-Kalau kamu butuh file dokumentasi:
+ pip install json2yaml
-### 🔹 JSON:
+==Catatan:==
-### 🔹 YAML (butuh converter, contoh pakai `json2yaml`):
+* Kita dapat integrasi Swagger manual (misalnya pakai Flask atau Express.js).
-```bash
+* Saat ini, '''FastAPI sudah auto generate Swagger''' tanpa ribet coding dokumentasi manual.
-Kalau kamu mau integrasi Swagger manual (misalnya pakai Flask atau Express.js), tinggal bilang aja. Tapi buat sekarang, **FastAPI udah auto generate Swagger** tanpa ribet coding dokumentasi manual.
+==Pranala Menarik==
-Mau ku buatin template project-nya sekalian dalam folder ZIP? Atau mau lanjut integrasi auth/token dan semacamnya?
+* [[Web Programming]]