Firebase API Example

Turkish | English

Bu proje, Python Flask kütüphanesini kullanarak Firebase veritabanına erişim sağlayan bir API geliştirmeyi amaçlar. Firebase, kullanıcıların gerçek zamanlı verileri depolamalarına, senkronize etmelerine ve paylaşmalarına olanak tanıyan bir bulut tabanlı veritabanıdır. API, kullanıcılara veri ekleme, görüntüleme ve silme işlemlerini gerçekleştirme yeteneği sunar.

Proje'nin Özellikleri:

• Veri tabanında ki verileri okuyabilirsiniz
• Veri tabanına JSON formatından veri ekleyebilirsiniz
• Veri tabanında ki tabloları görüntüleyebilirsiniz.
• Veri tabanında ki tabloları silebilirsiniz.

Proje de Kullanılan Kütüphaneler;

• Firebase

• Flask

Proje'yi İndirme

git clone REPO_URL
cd firebase-api

Kurulum

Firebase'den proje oluşturduktan sonra, Project settings sekmesindenden service accounts dan Python'ı seçip Generate new private key butonuna basıp API bilgilerini indirin, indirdikten sonra ismini key.json yapıp firebase/api klasörüne attın.

---

Gerekli kütüphanelerini kurulumu ve projeyi çalıştırma

pip install -r requirements.txt
# Gerekli kütüphanelerini kurulumu
python main.py
# main.py dosyasını çalıştırır.

Veri tabanında ki verileri görüntüleme, veri ekleme ve silme

---

Verileri görüntülemek için aşağıda ki URL'e GET istediği atmanız yeterli.

http://127.0.0.1:5000/user/list

Example

---

Veri tabanına veri ekleme için ise aşağıda ki URL'e eklemek istediğiniz veri ile POST istediği atmanız yeterli.

http://127.0.0.1:5000/user/add

Example

---

Veri tabanında ki document görüntülemek için aşağıda ki URL'e GET istediği atmanız yeterli.

http://127.0.0.1:5000/user/doclist

Example

---

Veri tabanından document silmek için aşağıda ki URL'e DELETE istediği atmanız yeterli.

http://127.0.0.1:5000/user/delete/<document_id>

Example

---

Lütfen yukarıdaki URL'lerin, projeyi makinenizde yerel olarak çalıştırdığınızı varsaydığını unutmayın. Projeyi farklı bir sunucuda veya bağlantı noktasında çalıştırıyorsanız, temel URL'yi uygun şekilde değiştirin.

---

Firebase API Example

This project aims to develop an API that accesses the Firebase database using the Python Flask library. Firebase is a cloud-based database that allows users to store, synchronize, and share real-time data. The API provides users with the ability to add, view, and delete data.

Features of the Project:

• Ability to read data from the database
• Ability to add data to the database in JSON format
• Ability to view tables in the database
• Ability to delete tables in the database

Libraries Used in the Project:

• Firebase

• Flask

Project Setup

git clone REPO_URL
cd firebase-api

Installation

After creating a project on Firebase, go to the Project settings tab, select Python from the service accounts, and click the Generate new private key button to download the API credentials. Rename the downloaded file to key.json and place it in the firebase/api folder.

---

Installing the required libraries and running the project

pip install -r requirements.txt
# Install the required libraries
python main.py
# Run the main.py file

Viewing, Adding, and Deleting Data in the Database

---

To view the data in the database, simply send a GET request to the following URL:

http://127.0.0.1:5000/user/list

Example

---

To add data to the database, send a POST request to the following URL with the data you want to add:

http://127.0.0.1:5000/user/add

Example

To view the documents in the database, send a GET request to the following URL:

http://127.0.0.1:5000/user/doclist

Example

To delete a document from the database, send a DELETE request to the following URL with the document ID:

http://127.0.0.1:5000/user/delete/<document_id>

Example

---

Please note that the above URLs assume you are running the project locally on your machine. Modify the base URL accordingly if you are running the project on a different server or port.