Python 3.9.5 Sanic OpenAPI — Part 2
Özet
Önceki yazımızda aşağıdaki konular üzerinde durmuştuk.
- Sanic Basic App oluşturma
- Sanic projesine swagger ekleme
- Swagger konfigürasyonu
- Dekoratörler
Bu yazımızda swagger modelleri üzerinde duracağız.
Models
Swagger’da modeller api dökümanı oluştururken oldukça önemlidir. Request Body, model fieldları sayesinde dökümante edilir. Modeller classlar ile ifade edilir. Aşağıda, içerisinde User modeli kullanılan ve api’nin request body’si User modeli olan örnek bir app verilmiştir.
Modellerin içerisindeki fieldların type’ları mutlaka verilmelidir. Aşağıdaki data type’lara izin verilmektedir.
- Integer, Float, String, Boolean, Date, DateTime, File, Dictionary, JsonBody, List, Object
Field’ların type’ları direk tip isimleri ile verilebilir. Ayrıca type’ları class şeklinde verebiliriz.
Aşağıda tüm data type’lar kullanılarak oluşturulan bir model örneği verilmiştir. Bu model request body olarak kullanılmıştır.
Göründüğü üzere model dökümanın alt kısmına yazılmıştır. API’nin içine baktığımızda ise request body aşağıdaki gibi görülmektedir.
Bu yazımızda swagger modellerini öğrendik. Sonraki yazılarımda görüşmek üzere!
Kaynakça
