DEV Community

Cover image for Backstage Geliştirici Portalı: Kapsamlı Rehber ve En İyi Uygulamalar
Tobias Hoffmann
Tobias Hoffmann

Posted on • Originally published at apidog.com

Backstage Geliştirici Portalı: Kapsamlı Rehber ve En İyi Uygulamalar

Backstage geliştirici portalı, modern yazılım ekiplerinin karmaşık ekosistemlerini yönetmek için Spotify tarafından açık kaynak olarak geliştirilen bir platformdur. Tüm yazılım bileşenlerini, API'leri, servisleri ve altyapıyı tek bir merkezi arayüzde keşfetmenizi, belgelemenizi ve yönetmenizi sağlar.

Apidog'u bugün deneyin

Kuruluş büyüdükçe ve hizmetler çeşitlendikçe, dokümantasyon, sahiplik ve bağımlılık yönetimi zorlaşır. Backstage geliştirici portalı, merkezi ve özelleştirilebilir yapısıyla görünürlük, keşfedilebilirlik ve self servis imkânları sunarak bu sorunları çözer.

Backstage Geliştirici Portalının Önemi

  • Bilgi Merkezileşmesi: Tüm dokümantasyon, API özellikleri, sahiplik ve altyapı araçları tek merkezde toplanır.
  • Geliştirilmiş Geliştirici Deneyimi: Kaynaklara kolay erişim sağlar, bilişsel yükü azaltır.
  • Self Servis Otomasyonu: Geliştiriciler, manuel onaylara gerek kalmadan servis ve API oluşturup dağıtabilir.
  • Tutarlılık ve Uyumluluk: Şablonlar ve otomatik kontrollerle organizasyon standartlarını uygular.
  • Ölçeklenebilirlik: Yüzlerce mikroservis ve ekip için uygun altyapı sunar.

Backstage portalı, hızlı ve sorunsuz mühendislik organizasyonlarının temelidir.

Backstage Geliştirici Portalının Temel Özellikleri

1. Yazılım Kataloğu

Tüm yazılım bileşenlerinizi (servisler, kütüphaneler, API’ler, veri hatları vb.) merkezi bir katalogda toplayın. Her girişte:

  • Sahiplik (ekip/birey)
  • Açıklama ve dokümantasyon linkleri
  • Kaynak kodu deposu
  • Dağıtım ve ortam bilgisi
  • Bağımlılıklar

Bu sayede sahiplik karmaşasını ortadan kaldırabilir, bileşenlerinizi hızlıca bulabilirsiniz.

2. API Yönetimi

API dokümantasyonu ve kullanımı kritik önem taşır. Backstage, OpenAPI, Swagger ve GraphQL gibi API tanımlarını destekler, dokümantasyonu interaktif olarak gösterir.

Uygulama Adımı: Apidog ile API’lerinizi tasarlayıp ve belgeleyin. Ardından bu dokümantasyonu Backstage’e entegre ederek uçtan uca API yönetimini sağlayın.

3. Yazılım Şablonları

Backstage’in şablonlarıyla ekipler; güvenli, standart ve hızlı servis, kütüphane veya altyapı bileşeni oluşturabilir. Şablonlar:

  • Teknoloji yığını seçimi
  • Güvenlik ve uyumluluk kontrolleri
  • Standart dokümantasyon
  • CI/CD entegrasyonu

Standart şablonlarla işe alım süresini kısaltın, teknik borcu azaltın.

4. Eklentiler Ekosistemi

Backstage, zengin eklenti desteğiyle DevOps araçları, bulut sağlayıcıları, izleme ve güvenlik sistemleriyle entegre olur. Yaygın entegrasyonlar:

  • Kubernetes kümeleri
  • CI/CD (Jenkins, GitHub Actions, GitLab CI)
  • Olay yönetimi
  • API dokümantasyon araçları (ör. Apidog)
  • Güvenlik panoları

5. Arama ve Keşif

Servis, API, depo, dokümantasyon veya sahip aramasını merkezi ve hızlı şekilde yaparak bilgiye anında ulaşın.

6. Dokümantasyon Merkezi

Backstage, Markdown gibi formatlarda yazılmış belgeleri doğrudan servislerin yanında gösterir. Böylece güncel bilgiye tek tıkla ulaşılır.

Kuruluşlar Backstage Geliştirici Portalını Nasıl Kullanıyor?

Yeni Geliştiricileri İşe Alma

  • Hizmet ve API kataloğunu inceleme
  • Sahiplik ve bağımlılıkları hızlıca görme
  • Güncel işe alım rehberlerine erişim
  • Şablonlarla hızlı servis oluşturma

Bu pratikler, işe alım süresini ve adaptasyon zorluğunu azaltır.

Hizmet Sahipliği ve Sorumluluğu

  • Yetim/atıl servislerin önlenmesi
  • Olay ve soruların doğru ekibe yönlendirilmesi
  • Servis sağlığı ve dağıtım takibi

API Tasarımı ve Dokümantasyonu

API’lerinizi Apidog ile tasarlayın, belgeleyin ve Backstage portalda herkese açık hale getirin. Kod, sahip ve dokümantasyon tek yerde bulunsun.

Self Servis Altyapı

Backstage portalından yeni ortam oluşturma, bulut kaynağı sağlama veya mikroservis dağıtımı işlemlerini self servis olarak yönetin.

Mühendislik Metrikleri ve Standartları

  • Kod kalitesi ve test kapsamı takibi
  • Uyumluluk ve güvenlik açıkları kontrolü
  • Kalite panoları ve skor kartları ile izleme

Bir Backstage Geliştirici Portalı Kurmak: En İyi Uygulamalar

1. Net Bir Katalogla Başlayın

Tüm servis, API ve kütüphaneleri kataloğa ekleyin. Sahiplik ve dokümantasyon bağlantılarını eksiksiz belirleyin.

2. API Araçlarını Entegre Edin

API tasarımı ve dokümantasyonunu Apidog ile yapın, dökümanları doğrudan Backstage’e aktararak merkezi görünürlük sağlayın.

3. Şablonlarla Standardizasyonu Uygulayın

Her yeni proje için şablonlar oluşturun. Güvenlik, uyumluluk ve dokümantasyonun başlangıçtan itibaren uygulanmasını sağlayın.

4. Kullanıcı Deneyimini Önceliklendirin

Kendi iş akışlarınıza uygun arayüz, marka ve eklenti özelleştirmeleri yaparak geliştiricilerin portalı aktif kullanmasını sağlayın.

5. Dokümantasyon Kültürünü Geliştirin

Takımlarınızı güncel kodla belgeleri birlikte tutmaya teşvik edin. Dokümantasyon güncellemelerini geliştirme sürecinizin parçası yapın.

6. Mümkün Olduğunda Otomatikleştirin

İşe alım, servis oluşturma ve operasyonları Backstage eklentileriyle otomatikleştirin. Self servis kapasitesini artırarak manuel engelleri kaldırın.

Gerçek Dünya Örneği: Wise ve Backstage Geliştirici Portalı

  • Tüm hizmet ve API belgelerini merkezileştirerek hızlı keşif sağladılar.
  • Sahiplik ve ekip eşlemelerini standartlaştırıp olay çözümünü hızlandırdılar.
  • API tasarım ve dokümantasyonunu (Apidog ile) standart iş akışına dahil ettiler.
  • Self servis şablonlarla ekiplerin hızlı ve standart servis oluşturmasını sağladılar.

Sonuç: Daha memnun geliştiriciler, daha hızlı işe alım ve daha yüksek mühendislik hızı.

Apidog'u Backstage Geliştirici Portalı ile Entegre Etmek

  1. API'leri Apidog'da Tasarlayın ve Test Edin: Apidog’un arayüzünde API uç noktalarını oluşturun, sahte yanıtlar ve interaktif dokümantasyon üretin.
  2. API Özelliklerini Backstage’e Aktarın: Apidog’dan OpenAPI/Swagger tanımlarını Backstage’e aktarın, kod ve sahiplik detaylarının yanında görüntüleyin.
  3. API Keşfini ve Yönetişimini Sağlayın: Geliştiriciler Backstage üzerinden API’leri arayabilir, test edebilir ve kullanım uyumluluğunu gözetebilir.

Bu entegrasyon; geliştirme döngüsünü hızlandırır, API benimsemesini artırır ve dokümantasyonun güncel kalmasını sağlar.

Backstage Geliştirici Portalı Hakkında Sıkça Sorulan Sorular

Hangi tür kuruluşlar Backstage geliştirici portalından en çok faydalanır?

Çoklu servis, API veya ekip içeren herhangi bir organizasyon. Özellikle dokümantasyon karmaşası veya self servis darboğazları yaşayanlar için faydalıdır.

Backstage geliştirici portalı açık kaynak mı?

Evet, Apache 2.0 lisansı ile açık kaynaklıdır. Ayrıca yönetilen ve ticari Backstage çözümleri de mevcuttur (ör. Spotify Portal, Roadie).

Backstage geliştirici portalı özelleştirilebilir mi?

Evet. Eklenti, tema ve iş akışı özelleştirmeleriyle kurum ihtiyaçlarına göre genişletilebilir.

Backstage geliştirici portalı API yönetimiyle nasıl ilişkilidir?

API’leri merkezi olarak belgelemek, keşfetmek ve yönetmek için kullanılır. Apidog gibi araçlarla entegre edildiğinde API tasarımı, test ve dokümantasyonu daha güçlü hale gelir.

Sonuç: Backstage Geliştirici Portalı ile Mühendislik Ekibinizi Güçlendirin

Backstage geliştirici portalı; bilgi merkezileştirme, hızlı işe alım, standart uygulama ve self servis ile mühendislik operasyonlarını hızlandırır ve basitleştirir.

İster yeni başlıyor olun, ister yüzlerce servise ölçeklenin; Backstage ve Apidog gibi araçları entegre ederek geliştirici memnuniyetini artırabilir, operasyonel yükü azaltabilir ve teslimat hızınızı yükseltebilirsiniz.

Top comments (0)