Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Bu adımda, aşağıdaki adımları uygulayarak portalda bir API yayınlayacaksınız:
1. OpenAPI Belirtimi Oluşturma
2. Spesifikasyondan API proxy'si oluşturma
3. Bir API ürünü oluşturun
4. API'yi portalınızda yayınlama
1. Adım: OpenAPI spesifikasyonu oluşturun
Her OpenAPI Spesifikasyonu, API yaşam döngüsü boyunca bilgi kaynağı işlevi görür. API yaşam döngüsünün, geliştirmeden yayınlamaya kadar her aşamasında aynı spesifikasyon kullanılır.
OpenAPI Belirtimi oluşturmak için:
- Özellikler sayfasını açmak için sol gezinme çubuğunda Geliştir > Özellikler'i seçin.
- + Özellikler > URL'yi İçe Aktar'ı tıklayın.
- İçe aktarma iletişim kutusuna aşağıdaki bilgileri girin:
- İçe aktarma adı: helloworld
İçe aktarma URL'si: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml
Import'u (İçe aktar) tıklayın.
2. Adım: Özelliklerden bir API Proxy'si oluşturun
OpenAPI Specification'dan API'yi açıklayan bir API proxy'si oluşturun.
OpenAPI Specification'dan API proxy'si oluşturmak için:
- Özellikler sayfasında, imleci helloworld spesifikasyonunun üzerine getirerek işlemler menüsünü görüntüleyin.
- Spesifikasyondan API proxy'si oluşturmak için simgesini tıklayın.
Proxy Oluşturma sihirbazı açılır ve Ayrıntılar sayfası, OpenAPI Specification'dan alınan değerler kullanılarak önceden doldurulur. - Açıklama alanını şu şekilde düzenleyin: hello world için API proxy'si.
- Sonraki'yi tıklayın.
Politikalar sayfasında:
- Güvenlik: Yetkilendirme bölümünde Geçiş (yetkilendirme yok) seçeneğini belirleyin.
- Güvenlik: Tarayıcı bölümünde, CORS üstbilgileri ekle'yi seçin .
Sonraki'yi tıklayın.
Akışlar sayfasında tüm işlemlerin seçili olduğundan emin olun ve İleri'yi tıklayın.
Virtual Hosts (Sanal Ana Bilgisayarlar) sayfasında tüm sanal ana makinelerin seçili olduğundan emin olun ve Next (İleri) seçeneğini tıklayın.
Özet sayfasında, İsteğe Bağlı Dağıtım altında dağıtım yapmak istediğiniz ortamı seçin.
Create'i (Oluştur) tıklayın.
Özet sayfasında, yeni API proxy'nizin başarıyla oluşturulduğu ve test ortamınıza dağıtıldığına dair bir onay görürsünüz.
3. Adım: Bir API ürünü oluşturun
API tüketicilerinize göstermek istediğiniz API kaynaklarını içeren bir API ürünü oluşturun.
API ürünü oluşturmak için:
- API Ürünleri sayfasını açmak için sol gezinme çubuğunda Yayınla > API Ürünleri'ni seçin.
-
+ API Ürünü'nü tıklayın.
Yeni Ürün sayfası görüntülenir. -
API ürününüz için Ürün Ayrıntıları'nı girin.
Not: Görünen Ad ve Açıklama alanları, API ürününü yayınladığınızda varsayılan olarak portalda görüntülenir. Değerleri, 4. Adım: API'yi portalınızda yayınlayın bölümünde düzenleyebilirsiniz.
Alan Değer Ad Merhaba Dünya Görünen Ad Merhaba Dünya Açıklama Basit hello world örneği Ortam API proxy'sinin dağıtılacağı ortamı seçin. Erişim Herkese açık Erişim isteklerini otomatik olarak onayla Etkin Kota (boş bırakın) İzin Verilen OAuth Kapsamları (boş bırakın) -
API kaynakları bölümünde, API ürününüze eklenecek API proxy'lerini tanımlamak için Proxy ekle'yi tıklayın.
API Kaynağı Ekle iletişim kutusu görüntülenir. - API Proxy'yi tıklayın (seçili değilse) ve listeden Örnek-Hedef-API'yi seçin.
- Ekle'yi tıklayın.
-
API ürününü kaydetmek için Kaydet'i tıklayın.
4. Adım: API'yi portalınızda yayınlayın
Müşterilerinizin hakkında bilgi edinmesini ve kullanmasını sağlamak için API'yi portalınızda yayınlayın.
API'yi portalınızda yayınlamak için:
- Portalınızda API'ler sayfasına gidin:
- Sol gezinme çubuğunda Yayınla > Portallar'ı seçin.
- Portalı açmak için My first portal (İlk portalım) satırını tıklayın.
- API'ler sayfasını görüntülemek için API kataloğu'nu tıklayın.
- +'yı tıklayın.
- Kataloğa bir API ürünü ekleyin iletişim kutusunda Hello World'ü seçin ve Sonraki'yi tıklayın.
- API ayrıntıları bölümünde, aşağıdaki seçenekleri yapılandırın:
- API'yi portalınıza yayınlamak için Yayınlandı (katalogda listelenir) seçeneğini belirleyin.
- Görünen resim için:
- Resim seç'i tıklayın.
- Resim seçin iletişim kutusundaki mevcut resimler listesinden home-background.jpg seçeneğini tıklayın.
- Select'i (Seç) tıklayın.
- Resmi önizleyin ve Seç'i tıklayın.
- Kategoriler için Başlayın'ı girin ve Enter tuşuna basın.
Diğer tüm değerleri varsayılan ayarlarında bırakın.
- OpenAPI Belirtiminizin anlık görüntüsünden API referans belgelerini otomatik olarak oluşturmak için API belgeleri bölümünde:
- OpenAPI dokümanı'nı seçin.
- Doküman Seç'i tıklayın.
- Spesifikasyonlarım sekmesini seçin (önceden seçilmemişse).
- Özellikler listesinden helloworld seçeneğini belirleyin.
- Select'i (Seç) tıklayın.
-
API ayrıntılarını kaydetmek için Kaydet'i tıklayın.
API referans belgelerini görüntülemek için:
- Canlı portaldaki değişiklikleri görüntülemek için Canlı Portal'ı tıklayın (veya başka bir sekmede açıksa canlı portalı yenileyin).
- Yayınlanan API'yi görüntülemek için üstteki gezinme çubuğunda API'ler seçeneğini tıklayın.
- API referans belgelerini görüntülemek için Hello World kartını tıklayın. API'nizi deneyin
Tebrikler! Eğitimi başarıyla tamamladınız. Daha fazla bilgi edinmeye hazır mısınız? Entegre portalınızı oluşturma sayfasına gidin.