python rest api

API istirahat sederhana oleh Python

Saya membangun API istirahat yang sangat mendasar dengan Python.

Bagaimana cara menggunakannya?

Anda dapat menggunakannya di VirtualEnv atau Docker.

Jika Anda ingin menggunakan VirtualEnv. Ikuti instruksi di bawah

Metode VirtualEnv

1. Buat VirtualEnv Anda dan Aktifkan VirtualEnv Anda Instal semua lib dari persyaratan.txt dengan perintah di bawah ini

pip install -r requirements.txt 

2. Sekarang buat file .env di direktori root Anda dan tambahkan teks atau string di bawah

 ALLOWED_HOSTS=*,127.0.0.1,
DATABASE_NAME=<your database name>
DATABASE_USERNAME=<your database username>
DATABASE_PASSWORD=<your datababse password>
DATABASE_HOST=<your database host>
DATABASE_PORT=5432

[NB: Anda perlu menginstal database PostgreSQL di mesin Anda jika tidak, Anda tidak dapat menggunakan proyek ini.]

3. Setelah pengaturan DB, Anda harus menjalankan perintah di bawah ini untuk membuat tabel di DB Anda.

python db_table_creation.py

Jangan lupa untuk mengaktifkan VirtualEnv Anda dan juga perintah ini akan berfungsi di direktori root proyek Anda.

[NB Saat ini saya menggunakan SQL mentah untuk membuat tabel, data kueri dari DB. Di masa depan saya memiliki rencana untuk memindahkan lebih banyak cara Pythonic, membuat model, migrasi dan juga saya akan mengimplementasikan ORM]

4. Proyek saat ini memiliki URL statis. IE saat ini URL Patten bukan prefek. URL di bawah hanya tersedia

Resep

Nama	Metode	Url	Terlindung
Daftar	GET	/recipes	✘
Membuat	POST	/recipes	✓
Mendapatkan	GET	/recipes/{id}	✘
Memperbarui	PUT/PATCH	/recipes/{id}	✓
Menghapus	DELETE	/recipes/{id}	✓
Kecepatan	POST	/recipes/{id}/rating	✘

5. Untuk mengakses URL yang dilindungi, Anda perlu menggunakan otentikasi dasar di klien Anda (misalnya tukang pos) dan gunakan kredensial di bawah

 username: vubon
password: 123456

Jika Anda ingin berubah. Buka Folder Server dan buka file default_user.py. Temukan akhir fungsi ususer_data dari file dan ubah nama pengguna dan kata sandi juga

6. Itu saja.

Metode Docker

1. Instal Docker di mesin Anda. Versi Docker saya adalah 18.06.0-CE dan Docker Compose Versi 1.22.0

2. Gunakan Versi yang sama Docker dan Docker Compose. Kecuali konfigurasi file Docker-compose.yml mungkin tidak cocok

3. Ikuti Langkah 2 dari Metode VirtualEnv. Sekarang buka file Docker-Compose.yml dan buka bagian Postgres. Gunakan nama DB ini, nama pengguna DB, kata sandi DB di file .env Anda. Ingatlah bahwa host basis data Anda adalah postgres .

4. Setelah Anda melakukan langkah 3. Jalankan perintah Bellow

[sudo] docker-compose up --build 

5. Hanya Anda yang perlu membangun pertama kali kecuali tidak perlu.

[sudo] docker-compose up

[NB Ingat jika Anda mengubah apa pun dalam file komposisi Docker atau DockerFile yang perlu Anda bangun dan juga jika Anda menambahkan LIBS baru dalam proyek Anda] 6. Ikuti Langkah 4 dari VirtualEnv untuk mengakses URL 7.

Kredit **

Saya mengadopsi banyak filosofi membentuk Django dalam proyek ini.

Terima kasih Django Team

Happy Coding