Geliştiriciler · Tasarım

Önce spesifikasyon. Sonra proxy. En son servis.

Apinizer'ın API Designer'ı bir OpenAPI taslağını alır, yönetişimli bir proxy üretir, bir mock yayınlar ve endpoint'i iş ortağı portalında listeler — ortada henüz hiçbir servis yokken.

OpenAPI-first design — For developers use case overview from Apinizer.
For developers · OpenAPI-first design

Sorun

Çoğu ekip spesifikasyonu yayından sonra yazar. Kontratlar işte böyle drift'e uğrar.

Mühendisler önce servisi yayınlar, sonra ona uyan OpenAPI'yi yazar — ve bir özellik doküman güncellemesi olmadan yayınlandığı ilk anda spesifikasyon eskir. Apinizer sırayı tersine çevirir: doğruluk kaynağı spesifikasyondur. Proxy, mock, portal, kontrat testi — hepsi ondan türetilir. Drift imkânsızdır çünkü yaşayacağı bir yer yoktur.

Yetenekler

Apinizer'ın buradaki rolü

Platform içinde spesifikasyon yazımı

OpenAPI 3.x taslağını platformda hazırlayın. İncelemeciler yorumlarını yerinde bırakır; spesifikasyon, dışa aktarılan değil, üzerinde çalışılan dokümandır.

Tek tıkla proxy üretimi

Spesifikasyondan yönetişimli bir proxy üretin. Kimlik doğrulama, hız limitleri ve doğrulama varsayılanları uygulanır — mühendisler zaten doğru olan bir başlangıç noktasından ince ayar yapar.

Kontrat odaklı mock'lar

Mock API aynı spesifikasyondan üretilir. Frontend'in, iş ortaklarının ve kontrat testlerinin önü anında açılır.

Üretimde doğrulama

İstek ve yanıt doğrulaması, gateway'de spesifikasyona göre zorunlu kılınır. Hatalı payload'lar, temiz hata mesajlarıyla uçta reddedilir.

Spesifikasyon yönetişimi

Zorunlu alanlar, adlandırma kuralları, kullanımdan kaldırma hijyeni — her PR'da kontrol edilir. Platform ekibi kuralları bir kez tanımlar; her ekip bundan yararlanır.

Çoklu protokol köprüleri

SOAP backend'in, gRPC servisinin veya saklı yordamın önünde OpenAPI — proxy, kontratı geçiş sırasında çevirir.

Kullanım senaryoları

Canlı ortamda bu şöyle görünür…

  • Bankacılık

    İstanbul'daki banka, her yeni endpoint'i önce bir spesifikasyon PR'ı olarak yayınlıyor

    Spesifikasyon Git'e düşüyor; CI, lint ve politika kontrollerini çalıştırıyor. Birleştirmede proxy ve mock üretiliyor; iş ortakları aynı gün mock üzerinden katılım sağlıyor.

  • Üretim

    Münih'teki OEM, 14 fabrika ekibini tek spesifikasyon şablonunda birleştiriyor

    Her fabrikanın API'leri aynı adlandırmayı, aynı kimlik doğrulamayı, aynı sürümlemeyi izliyor. Yeni fabrika çeyrekler değil, günler içinde katılıyor.

  • Kamu sektörü

    Stockholm'deki kurum, her spesifikasyonda ulusal standart alanları zorunlu kılıyor

    Zorunlu vatandaş kimlik formatı, zorunlu onay bayrağı, denetim etiketi — CI'da kontrol ediliyor. Zorunlu alanı eksik spesifikasyonlar incelemeden geçemiyor.

  • Telekom

    Madrid'deki operatör, iş ortağı portal sayfalarını spesifikasyondan otomatik üretiyor

    Portal sayfaları, kod örnekleri ve kontrat testlerinin tamamı spesifikasyondan türetiliyor. İş ortağı dokümanları asla bayatlamıyor.

  • Perakende

    Amsterdam'daki pazar yeri, hatalı payload'ları reddetmek için uçta doğrulama çalıştırıyor

    Mevcut servisler kısmi doğrulamaya devam ediyordu; Apinizer'ın spesifikasyon odaklı doğrulaması, hatalı çağrıları backend'ler görmeden reddediyor.

  • Sigorta

    Milano'daki sigortacı, eski SOAP backend'lerini OpenAPI proxy'leri üzerinden çeviriyor

    Designer spesifikasyonları SOAP operasyonlarına eşleniyor. Modern tüketiciler temiz REST görüyor; eski backend hiç değişmiyor.

  • Sağlık

    Prag'daki hastane, FHIR uyumlu spesifikasyonları kontrat kaynağı olarak yayınlıyor

    FHIR kaynakları spesifikasyonda eşleniyor; alt taraftaki EHR çevirisini proxy üstleniyor. Tedarikçi konnektörleri tasarım gereği birlikte çalışıyor.

  • Kamu

    Bakü'deki bakanlık, spesifikasyon lint'inde kullanımdan kaldırma hijyenini zorunlu kılıyor

    Kullanımdan kaldırma politikası: her operasyon bir sonlandırma tarihi beyan etmek zorunda. CI, tarihi olmayan spesifikasyonları reddediyor; bakanlık borcu yayına girmeden yakalıyor.

Kontrat, spesifikasyondur

OpenAPI'den yayınlayın. Varsayılan olarak yönetin.

30 dakikalık uygulamalı bir tanıtım — taslak, üretim, mock, yönetişim — seçtiğiniz bir Kubernetes üzerinde.