- Katılım
- 21 Ocak 2024
- Mesajlar
- 164
- Tepkime puanı
- 36
- Puanları
- 28
API nedir?
Bir API'yi (“Application Programming Interface”) farklı yazılım uygulamalarının birbirleriyle konuşmasını sağlayan bir aracı olarak düşünün. Python'da API'ler, kodunuzun diğer yazılım hizmetleri ve veri kaynaklarıyla sorunsuz bir şekilde etkileşime girmesini sağlamada çok önemli bir rol oynar.
Basitliği ve zarafeti ile bilinen Python, özellikle yeni başlayanlar olmak üzere programcılar arasında favoridir. API geliştirme söz konusu olduğunda, Python'un basit sözdizimi ve zengin kütüphaneleri onu tercih edilen bir seçenek haline getirir. İster basit bir hava durumu uygulaması ister karmaşık bir veri analiz aracı olsun, Python API entegrasyonunu çocuk oyuncağı haline getirir.
Bu yolculukta, API projeleriniz için yapı taşları olan Flask ve Django gibi çerçeveleri keşfederek kendi Python API'nizi nasıl oluşturacağınızı öğreneceksiniz. Ayrıca RESTful ilkelerine de değinerek API'lerinizin diğerleriyle iyi çalışmasını sağlayacağız.
Yeni başlayanlar için bu Python API eğitimine başlarken, unutmayın, her şey farklı uygulamaların birlikte sorunsuz çalışmasını sağlamakla ilgilidir. Bu yüzden, Python API'lerinin gücünü ortaya çıkarmaya ve fikirlerinizi hayata geçirmeye hazır olun!
Python'da API Geliştirmenin Temeller
Öncelikle, API'ler (Uygulama Programlama Arayüzleri) farklı yazılım uygulamalarının birbirleriyle iletişim kurmasını sağlayan gizli sos gibidir. Bir restoranda olduğunuzu (sizin uygulamanız) ve bir yemek sipariş ettiğinizi (bir veri veya hizmet talebi) düşünün. Mutfak (başka bir uygulama) yemeğinizi hazırlıyor ve size geri teslim ediyor. İşte bir API'nin yaptığı budur - istekleri alır, işler ve yanıtları döndürür.
Şimdi, API'ler neden çok önemlidir? Python uygulamalarınızın sosyal medya platformları, veritabanları ve hatta IoT cihazları gibi diğer yazılımlarla etkileşime girmesini sağlarlar. Bu, dinamik, birbirine bağlı uygulamalar oluşturmak için bir olasılıklar dünyasının kapılarını açar.
Basit bir Python API örneği ile ellerimizi kirletelim. Dostça bir selamlama döndüren temel bir API oluşturacağız. Bu yeni başlayanlar için bir Python API eğitimidir, bu yüzden basit ve açık tutacağız.
Python:
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello_world():
return 'Hello, World!'
if __name__ == '__main__':
app.run()
Yaptığımız şey şu:
API'ler oluşturmak için hafif bir Python framework'ü olan Flask'ı içe aktarıyoruz.
Flask sınıfının bir örneğini oluşturuyoruz.
Varsayılan URL uç noktası olan bir rota / tanımlıyoruz.
hello_world fonksiyonunda basit bir selamlama döndürüyoruz.
Son olarak, uygulamayı çalıştırıyoruz.
Bu kodu çalıştırdığınızda ve tarayıcınızda http://localhost:5000/ adresine gittiğinizde şunları göreceksiniz:
Hello, World!
Unutmayın, Python API'leri dünyası çok geniştir ve fırsatlarla doludur. İlerledikçe, daha karmaşık API'ler oluşturmayı, veritabanlarıyla entegre olmayı ve güvenlik katmanları eklemeyi öğreneceksiniz. Ancak her yolculuk tek bir adımla başlar ve siz de kendi adımınızı attınız!
API Geliştirme için Python Ortamını Kurma
Harika API'ler oluşturmaya başlamadan önce, araç kutumuzu hazırlamamız gerekir. Bunu gurme bir yemek pişirmeye başlamadan önce mutfağınızı hazırlamak gibi düşünün. Python API eğitimimizin bu bölümünde, Python ortamınızı tüm temel araçlar ve kütüphanelerle kurmanız için size rehberlik edeceğim. Düşündüğünüzden daha basit!
İlk olarak, Python'un makinenizde kurulu olması gerekiyor. Henüz kurmadıysanız, Python resmi web sitesine gidin ve en son sürümü indirin. Mutfağınız için en taze malzemeleri seçmek gibi!
Sonra, sanal bir ortama ihtiyacımız olacak. Neden mi? Mutfağınızın geri kalanını bozmadan deney yapabileceğiniz kişisel bir çalışma alanına sahip olmak gibi. İşte nasıl kuracağınız:
python -m venv myapienv
Bu komut myapienv adında bir sanal ortam oluşturur. Etkinleştirmek için şunu kullanın:
Şimdi, API'ler oluşturmak için hafif framework'ümüz olan Flask'ı yükleyelim. Etkinleştirilmiş sanal ortamınızda şunu çalıştırın:
pip install Flask
Flask, API yemeklerinizi hazırlamak için gerekli olan çok yönlü bir mutfak aracı gibidir.
Son olarak, gerçek dünyadaki bir proje için, HTTP isteklerini işlemek için requests veya veritabanı etkileşimleri için SQLAlchemy gibi ek kütüphanelere ihtiyacınız olabilir. Bunları gerektiği gibi yükleyin:
pip install requests SQLAlchemy
Ve işte oldu! Python API geliştirme ortamınız hazır. Artık harika API'ler geliştirmeye başlamaya hazırsınız!
Unutmayın, bu kurulum sadece bir başlangıç. Daha fazlasını keşfettikçe, API projelerinize lezzet katabilecek başka araçlar ve kütüphaneler bulacaksınız. Meraklı kalın ve denemeye devam edin!
İlk Python API'nizi Oluşturmak
Pekala, kolları sıvamanın ve Python API eğitimimizin heyecan verici kısmına dalmanın zamanı geldi - ilk API'nizi oluşturun! Yeni, basit ama keyifli bir yemek yaratmak üzere olan bir şef olduğunuzu hayal edin. İşte biz de burada bunu yapıyoruz, ama kodla.
Size o anki saati söyleyen temel bir API oluşturacağız. Akıllı bir saate saati sormak gibi, ama saat sizin API'niz ve zaman da onun sağladığı veri.
Adım 1: Flask Uygulamasını Kurma
Öncelikle, sanal ortamınızda Flask'ın kurulu olduğundan emin olun. Eğer yoksa, terminalinizde pip install Flask komutunu çalıştırın.
Şimdi, bir Flask uygulaması kurarak başlayalım. Yeni bir dosya oluşturun, buna time_api.py diyelim ve favori metninizde açın
Burada, Flask'ı içe aktarıyoruz ve Flask sınıfının bir örneğini oluşturuyoruz. Bu örnek bizim WIP API'mizdir.
Python:
from flask import Flask
app = Flask(__name__)
Adım 2: Rota Oluşturma
Ardından, bir rota oluşturmamız gerekiyor. Rotaları bir restoranın menüsündeki farklı yemekler gibi düşünün. Her rota, API'nin işleyebileceği farklı bir uç noktadır.
Python:
@app.route('/time')
def get_current_time():
from datetime import datetime
now = datetime.now()
current_time = now.strftime("%H:%M:%S")
return current_time
Bu kod parçasında, bir . Birisi bu rotayı ziyaret ettiğinde get_current_time fonksiyonu çalışacaktır. Geçerli zamanı alır ve güzel bir şekilde biçimlendirir.
Adım 3: API'yi Çalıştırma
API'mizi hayata geçirmek için time_api.py dosyasının sonuna şu satırları ekleyin:
Python:
if __name__ == '__main__':
app.run(debug=True)
Bu, Python'a bu betiği doğrudan çalıştırırsak Flask uygulamasını çalıştırmasını söyler.
Adım 4: İş Başında Görmek
Komut dosyanızı çalıştırın:
python time_api.py
Web tarayıcınızı açın ve http://localhost:5000/time adresine gidin. Evet! Geçerli saatin görüntülendiğini göreceksiniz.
Çıktı:
21:45:22
(API'ye eriştiğinizde çıktınız geçerli saati gösterecektir).
Ve işte oldu! Basit ama işlevsel bir Python API'si oluşturdunuz. Bu, API geliştirme dünyasındaki ilk başarılı yemeğiniz gibi. Buradan itibaren olasılıklar sonsuzdur. API'nizi daha fazla rota içerecek, farklı veri türlerini işleyecek ve hatta veritabanlarıyla etkileşime girecek şekilde genişletebilirsiniz.
Python API Framework'lerini Keşfetmek
Python API eğitim serüvenimizde, ticaretin araçları olan Python API frameworkleri hakkında konuşmanın zamanı geldi. Bu frameworkleri farklı markalardaki mutfak aletleri gibi düşünün. Her birinin kendine özgü özellikleri vardır ve doğru olanı seçmek yemek pişirmenizi (veya kodlamanızı!) çok daha verimli hale getirebilir.
Flask: Hafiflik Şampiyonu
İlk sırada Flask var. Kullanışlı bir blender gibi - kullanımı kolay, çok karmaşık değil, küçük ve orta ölçekli projeler için mükemmel. Flask basitliği ve esnekliği ile bilinir. Çok fazla zil ve ıslık ile birlikte gelmez, bu da onu istediğiniz gibi özelleştirebileceğiniz anlamına gelir.
İşte Flask'ın nasıl çalıştığını gösteren küçük bir pasaj:
Python:
from flask import Flask
app = Flask(__name__)
@app.route('/')
def home():
return "Welcome to my Flask API!"
if __name__ == '__main__':
app.run()
Bu kod temel bir Flask uygulaması kurar. Ana sayfayı ziyaret ettiğinizde sizi bir mesajla karşılıyor. Basit, değil mi?
Django: Tam Özellikli Framework
Sırada Django var. Django'yu çok fonksiyonlu bir mutfak robotu olarak hayal edin. Flask'tan daha karmaşıktır ancak veritabanı etkileşimleri için ORM (Object-Relational Mapper) gibi birçok özellik ile birlikte gelir, bu da onu daha büyük uygulamalar için harika kılar.
Django'ya bir bakış:
Python:
from django.http import HttpResponse
from django.urls import path
def home(request):
return HttpResponse("Welcome to my Django API!")
urlpatterns = [
path('', home),
]
Django, Flask'a kıyasla perde arkasında çok daha fazla işlem yapar ve bu da onu daha büyük projeler için sağlam bir seçim haline getirir.
Diğer Frameworkler
FastAPI ve Tornado gibi her biri kendine özgü güçlü yönlere sahip başka frameworkler de vardır. Örneğin FastAPI, hızı ile bilinir ve eşzamansız destekli API'ler oluşturmak için harikadır.
Doğru Olanı Seçmek
Doğru framework'ü seçmek projenizin ihtiyaçlarına bağlıdır. Python API geliştirme konusunda yeniyseniz, basitliği nedeniyle Flask ile başlamak iyi bir fikirdir. Çok sayıda hareketli parçaya sahip daha karmaşık uygulamalar için Django tercih edilebilir.
Unutmayın, en iyi framework projenizin gereksinimlerine ve konfor seviyenize uygun olandır. Bu bir blender ile mutfak robotu arasında seçim yapmaya benzer - her ikisi de harikadır, ancak seçiminiz ne pişirdiğinize bağlıdır!
Python ile RESTful API'ler Tasarlama
RESTful API'leri dijital iletişim için bir dizi kural veya görgü kuralları olarak düşünün. Tıpkı kibar bir dil kullanmanın konuşmaları daha akıcı hale getirmesi gibi, RESTful ilkelerini takip etmek de API'leri daha verimli ve kullanıcı dostu hale getirir.
RESTful İlkelerini Anlamak
REST ( Representational State Transfer) tamamen durumsuz iletişim ve sunucu yanıtlarının kaynak olarak ele alınmasıyla ilgilidir. Bu kaynaklar, web sayfalarıyla etkileşimimize benzer şekilde GET, POST, PUT ve DELETE gibi HTTP istekleri kullanılarak manipüle edilir.
Basit Bir RESTful API Örneği
Flask kullanarak temel bir RESTful API oluşturalım. Bir görev listesini yöneten bir API oluşturacağız. Görevleri ekleyebileceğiniz, görüntüleyebileceğiniz, güncelleyebileceğiniz ve silebileceğiniz dijital bir yapılacaklar listesine sahip olmak gibi.
Adım 1: Kurulum
İlk olarak, Flask'ın Python ortamınızda kurulu olduğundan emin olun. Ardından, task_api.py adında yeni bir Python dosyası oluşturun.
Adım 2: Kodu Yazma
İşte görev API'mizin basitleştirilmiş bir sürümü:
Python:
from flask import Flask, jsonify, request
app = Flask(__name__)
tasks = []
@app.route('/tasks', methods=['GET'])
def get_tasks():
return jsonify({'tasks': tasks})
@app.route('/tasks', methods=['POST'])
def add_task():
task = request.json.get('task', '')
tasks.append(task)
return jsonify({'task': task}), 201
@app.route('/tasks/<int:task_id>', methods=['DELETE'])
def delete_task(task_id):
tasks.pop(task_id)
return jsonify({'result': True})
if __name__ == '__main__':
app.run(debug=True)
Adım 3: Kodu Anlama
Flask'tan gerekli modülleri içe aktarıyoruz.
tasks bizim basit bellek içi veri depomuzdur (not defterindeki bir liste gibi).
Farklı HTTP yöntemleri için rotalar tanımlıyoruz: Görevleri almak için GET, yeni bir görev eklemek için POST ve bir görevi kaldırmak için DELETE.
JSON yanıtlarını göndermek için jsonify kullanılır.
Adım 4: API'yi Test Etme
task_api.py dosyasını çalıştırın ve API'nizle etkileşim kurmak için Postman gibi bir araç veya tarayıcı kullanın. Görev ekleyebilir, listeyi görüntüleyebilir veya görevleri silebilirsiniz.
Çıktı:
RESTful API'ler için En İyi Uygulamalar
Uç noktalarınız için açık ve tutarlı adlandırma kuralları kullanın.
API'nizi durumsuz tutun: her çağrı sunucunun ihtiyaç duyduğu tüm bilgileri içermelidir.
İsteklerin başarılı veya başarısız olduğunu belirtmek için uygun HTTP durum kodlarını kullanın.
Python'da RESTful API'ler tasarlamak, iyi organize edilmiş bir kütüphane oluşturmak gibidir. Her kitabın (kaynağın) bir yeri vardır ve kitapları ödünç almak, iade etmek veya eklemek için net bir sistem (HTTP yöntemleri) vardır. Her şey veri alışverişi için uyumlu bir ortam yaratmakla ilgilidir!
Python API'lerinin Güvenliğini Sağlama
API'nizi eviniz olarak düşünün. Tıpkı ön kapınızı açık bırakmayacağınız gibi, API'nizi de korumasız bırakmamalısınız. Kimlik doğrulama ve yetkilendirme tekniklerini kullanarak Python API'lerinizi nasıl güvence altına alacağınızı inceleyelim.
Kimlik Doğrulama ve Yetkilendirme: Aradaki Fark Nedir?
Kimlik doğrulamayı bir kulüpte kimlikleri kontrol eden bir fedai gibi düşünün. Kim olduğunuzu doğrulamakla ilgilidir. Diğer yandan yetkilendirme, VIP erişimine sahip olup olmadığınıza karar veren fedai gibidir. Ne yapmanıza izin verildiği ile ilgilidir.
Basit Bir Kimlik Doğrulama Örneği
Bu örnek için yine Flask kullanacağız. API'mize temel bir kimlik doğrulama katmanı ekleyelim.
Python:
from flask import Flask, request, jsonify
app = Flask(__name__)
AUTHORIZED_USERS = {"admin": "secret"}
@app.route('/secure-data')
def secure_data():
auth = request.authorization
if not auth or not check_user(auth.username, auth.password):
return jsonify({"message": "Unauthorized"}), 401
return jsonify({"message": "Welcome to the secure data!"})
def check_user(username, password):
return AUTHORIZED_USERS.get(username) == password
if __name__ == '__main__':
app.run(debug=True)
Kodu Çözmek
Basit bir kullanıcı veritabanı olarak AUTHORIZED_USERS sözlüğümüz var.
secure_data fonksiyonunda, kullanıcının kimliğinin doğrulanıp doğrulanmadığını kontrol ederiz.
check_user fonksiyonu kullanıcı adı ve şifreyi doğrular.
API'yi Test Etme
secure-data adresine eriştiğinizde sizden bir kullanıcı adı ve şifre istenecektir. Yalnızca doğru kimlik bilgileri size güvenli verilere erişim sağlayacaktır.
Çıktı:
Accessing with correct credentials: {"message": "Welcome to the secure data!"}
Accessing with wrong credentials: {"message": "Unauthorized"}
API Güvenliği için En İyi Uygulamalar
Aktarım sırasında verileri şifrelemek için her zaman HTTPS kullanın.
Hassas verileri güvenli bir şekilde saklayın (düz metin değil, karma parolalar kullanın).
Çerçevelerinizi ve kütüphanelerinizi düzenli olarak güncelleyin ve yamalayın.
Python API'nizin güvenliğini sağlamak, geceleri kapılarınızı ve pencerelerinizi kilitlemek gibidir. Kötü adamları dışarıda tutmak ve değerli verilerinize yalnızca doğru kişilerin erişebilmesini sağlamak için gerekli bir adımdır.
Veritabanını Python API ile Entegre Etme
Bir veritabanını kütüphane gibi düşünün. Tıpkı bir kütüphanenin kitapları kolay erişim için düzenlemesi gibi, bir veritabanı da API'niz için verileri düzenler. Hem SQL hem de NoSQL veritabanlarını bir Python API'sine nasıl bağlayacağımızı ve onu güçlü bir veri işleme makinesine nasıl dönüştüreceğimizi inceleyeceğiz.
SQL Veritabanları: Yapılandırılmış ve Güvenilir
MySQL veya PostgreSQL gibi SQL veritabanları, titizlikle düzenlenmiş kitap rafları gibidir. Yapılandırılmış veriler için mükemmeldirler. Flask ve hafif bir SQL veritabanı olan SQLite kullanarak Python API'mize bir SQL veritabanı bağlayalım.
SQLite Veritabanı Kurma
Öncelikle Flask-SQLAlchemy'yi kurmamız gerekiyor:
pip install Flask-SQLAlchemy
Şimdi biraz kod yazalım:
Python:
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///mydatabase.db'
db = SQLAlchemy(app)
class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(50))
@app.route('/add_user/<name>')
def add_user(name):
user = User(name=name)
db.session.add(user)
db.session.commit()
return f"User {name} added."
if __name__ == '__main__':
db.create_all()
app.run(debug=True)
API'nin Test Edilmesi
Alice adında bir kullanıcı eklemek için http://localhost:5000/add_user/Alice adresini ziyaret edin. API, verileri depolamak için SQLite veritabanı ile etkileşime girer.
NoSQL Veritabanları: Esnek ve Ölçeklenebilir
MongoDB gibi NoSQL veritabanları, içine her şeyi atabileceğiniz kutulardan oluşan bir oda gibidir - yapılandırılmamış veriler için mükemmeldir. Bir NoSQL veritabanını entegre etmek benzer adımları içerir, ancak MongoDB için Flask-PyMongo gibi farklı bir kütüphane ile.
Python API'sinde Gelişmiş Özellikler
Bu özellikleri API'nize süper güçler eklemek gibi düşünün - performansı, verimliliği ve kullanıcı deneyimini geliştirirler. Hız sınırlama, önbelleğe alma ve asenkron çağrılar hakkında konuşacağız.
1. Hız Sınırlama: Kalabalığı Yönetmek
API'nizin popüler bir kafe olduğunu düşünün. Aynı anda çok fazla kişi gelirse hizmet yavaşlar. Hız sınırlama bir kapıcı gibidir, belirli bir süre içinde yalnızca belirli sayıda isteğe izin verilmesini sağlar. Bu, API'nizin aşırı yüklenmesini önler.
Flask kullanarak temel hız sınırlamasını uygulayalım:
Python:
from flask import Flask
from flask_limiter import Limiter
from flask_limiter.util import get_remote_address
app = Flask(__name__)
limiter = Limiter(app, key_func=get_remote_address)
@app.route('/limited')
@limiter.limit("5 per minute")
def limited():
return "This route is rate-limited!"
if __name__ == '__main__':
app.run(debug=True)
Burada, /limited rotasına dakikada sadece 5 istek yapılmasına izin vermek için flask_limiter kullanıyoruz.
2. Önbellekleme: Siparişleri Hatırlama
Önbellekleme, favori siparişinizi hatırlayan bir barista gibidir. Yanıtları depolar, böylece aynı istek tekrar yapıldığında API bunu daha hızlı sunabilir.
Önbellekleme için Flask-Caching gibi kütüphaneleri kullanabilirsiniz:
Python:
from flask import Flask
from flask_caching import Cache
app = Flask(__name__)
app.config['CACHE_TYPE'] = 'simple'
cache = Cache(app)
@app.route('/')
@cache.cached(timeout=50)
def home():
return "This response is cached for 50 seconds."
if __name__ == '__main__':
app.run(debug=True)
Bu kod, ev rotasının yanıtını 50 saniye boyunca önbelleğe alır.
3. Eşzamansız Çağrılar: Birden Fazla Tabloya Hizmet Verme
Eşzamansız çağrılar, API'nizin aynı anda birden fazla isteği, aynı anda birkaç masaya hizmet veren bir garson gibi işlemesine olanak tanır. Bu özellikle uzun süren işlemler için kullanışlıdır.
Python'da, asenkron uç noktalar oluşturmak için FastAPI gibi framework'leri kullanabilirsiniz:
Python:
from fastapi import FastAPI
import asyncio
app = FastAPI()
@app.get('/async')
async def read_async():
await asyncio.sleep(1)
return "This is an asynchronous response!"
Bu son nokta bir gecikmeyi simüle eder (kahve hazırlamak gibi) ve ardından bir yanıt döndürür.
Toparlayalım
Bu gelişmiş özelliklerde (hız sınırlama, önbelleğe alma ve zaman uyumsuz çağrılar) uzmanlaşmak, API'nizi yüksek teknolojili bir araç setiyle donatmak gibidir. API'nizin trafiği verimli bir şekilde idare edebilmesini, hızlı yanıt verebilmesini ve birden fazla isteği sorunsuz bir şekilde yönetebilmesini sağlarlar.
Python API'lerini Test Etme ve Belgeleme
API'nizi test etmek ve belgelemek, onu dünyaya sunmadan önce çok önemlidir.
Bugün, Python API'lerini test etmek ve belgelemek, sorunsuz çalışmalarını ve kolay anlaşılır olmalarını sağlamak için kullanılan araçları ve teknikleri keşfedeceğiz.
1. Python API'nizi Test Etme: Tat Testi
Test, API'nizin beklendiği gibi davrandığından emin olmakla ilgilidir. Bu, bir tarifi takip etmek ve yemeğin doğru şekilde ortaya çıkmasını sağlamak gibidir.
API Testi için Postman Kullanımı
API testi için popüler bir araç Postman'dır. API geliştiricileri için İsviçre çakısı gibidir. API'nize istek gönderebilir, yanıtları kontrol edebilir ve hatta testleri otomatikleştirebilirsiniz.
İşte hızlı bir kılavuz:
Postman'i açın ve yeni bir istek oluşturun.
API'nizin endpoint URL'sini girin.
İstek türünü seçin (GET, POST, vb.).
İsteği gönderin ve yanıtı gözlemleyin.
Örneğin, bir API uç noktanız varsa /get-data, doğru verileri döndürdüğünden emin olmak için Postman'da test edebilirsiniz.
2. API'nizi Belgeleme: Tarif Kitabı
İyi dokümantasyon ayrıntılı bir yemek tarifi kitabı gibidir. Başkalarının API'nizi nasıl kullanacaklarını anlamalarına yardımcı olur.
API Dokümantasyonu için Swagger
Artık OpenAPI olarak bilinen Swagger, API'leri belgelemek için harika bir araçtır.Kullanıcıların tüm API rotalarınızı, parametrelerinizi görebilecekleri ve hatta bunları canlı olarak deneyebilecekleri web tabanlı bir kullanıcı arayüzü sağlar.
Swagger'ı bir Flask API ile nasıl entegre edeceğiniz aşağıda açıklanmıştır:
Python:
from flask import Flask
from flasgger import Swagger
app = Flask(__name__)
swagger = Swagger(app)
@app.route('/api/data')
def data_api():
"""
This is an example API endpoint.
---
responses:
200:
description: A list of data items.
"""
return "Data list"
if __name__ == '__main__':
app.run(debug=True)
Bunu çalıştırdığınızda, Swagger UI sunucunuzdaki /apidocs adresinde kullanılabilir olacak ve düzgün, etkileşimli bir dokümantasyon arayüzü sağlayacaktır.
Sonuç
Postman gibi araçlarla test etmek Python API'nizin güvenilir olmasını ve beklendiği gibi davranmasını sağlar. Swagger ile belgelemek, kullanıcı dostu ve anlaşılması kolay hale getirir. Birlikte, API'nizi yalnızca işlevsel değil, aynı zamanda kullanımı keyifli hale getiren gizli bileşenler gibidirler.