API Developer Portal Kurulumu

Bu doküman, Apinizer API Developer/Geliştirici Portalı'nın kurulumunu anlatmaktadır.

1) Giriş

API Tüketicilerinin (API Consumers), bir organizasyonun sunduğu API'lerle ilgili dökümantasyona erişebilecekleri, bunları test edebilecekleri, belirli kısıtlamalar içinde kullanabilecekleri ve bu konular hakkında soru sorup cevaplayabilecekleri son kullanıcı veya geliştirici portalidir.

API Geliştirici Portalı, diğer Apinizer ürünleri gibi Kubernetes Platformu üzerinde çalışır. Portal işlemleri için herhangi bir veritabanı kullanılmaz, bunun yerine doğrudan API Manager'ın sağladığı API'lerle etkileşim sağlanır.

2) Kurulum öncesi adımlar

Apinizer API Portalı'nın kurulumuna başlamadan önce şunlara dikkat edilmelidir:

• API Manager'ın kurulu olması gerekmektedir. API Manager Kurulumu için Apinizer Kurulumu ve Ayarları dökümanını inceleyiniz.
• Lisans anahtarınızda API Developer Portal'ının bulunması gerekmektedir.

3) Kurulum adımları

API Portal Kurulumu iki şekilde yapılmaktadır.

• Kubernetes yönetimi Apinizer üzerinden yapılıyorsa, API Manager üzerinden API Developer Portal kurulumu yapabilirsiniz.
• Kubernetes yönetimi Apinizer üzerinden yapılmıyorsa, Kubernetes'e manuel kurulum yapılabilir ve ardından API Manager ile bağlantı sağlanabilir.

3.1) Kişisel API erişimi için Token oluşturma

Token bilgileri, yeni bir token oluşturarak veya Profilim sayfasında mevcut bir token kullanılarak elde edilebilir.Personel tokenları genellikle apnz_ öneki ile başlar.

Token bilgisini aşağıdaki görselde bulunan alandan oluşturabilirsiniz.

3.2) API Developer Portal kurulumu

API Manager'da, Yönetim → Sunucu Yönetimi → Kubernetes Resources sayfasına gidin. Deployment & Pods sekmesinden API Portal'ı etkinleştirin. Gerekli tanımları yaparak kurulumu tamamlayın.

Açılan diyalogda, kurumunuza uygun olarak zorunlu alanları tanımlayın.

Ek değişkenler alanındaki Java Options ayarını yapılandırırken aşağıdaki uyarı dikkate alınmalıdır;

-Xmx ve -Xms parametreleri kullanıldığında, otomatik yığın (heap) boyutlandırması devre dışı bırakılır.

Apinizer, JVM Yığın (Heap) değerlerini konteyner içinde çalıştığından konteynere verilen belleğin %75.0'ini kullanacak şekilde ayarlar. 

UseContainerSupport varsayılan olarak aktif gelmektedir.

Eski bayraklar (flag) -XX: {Min | Max} RAMFraction artık kullanımdan kaldırıldı. 0.0 ve 100.0 arasında bir değer alan ve varsayılan olarak 75.0 olan yeni bir -XX: MaxRAMPercentage bayrağı (flag) vardır. Bu nedenle, 1 GB bellek sınırı varsa, JVM yığını (heap) varsayılan olarak ~ 750 MB ile sınırlıdır.

Detaylı bilgi için tıklayınız.

3.2.2) API Developer Portal kurulumu API Manager üzerinden yapılmayacaksa

API Developer Portali'nin manuel olarak kurulması için aşağıdaki adımlar takip edilmelidir.

Önemli: API Manager API adresi ve API Key/Token bilgisini içeren Kubernetes Secret oluşturulmalıdır. Aşağıdaki bilgiler kurumunuza göre doldurulmalıdır.

• apinizerManagementApiBaseUrl : API Developer Portal'in Apinizer Management API'lerini tüketebilmesi için gerekli olan API Manager üzerinde çalışan Management API adresidir. Örnek bir adres: http://apimanager-ui-ip-address:port
• apiKey: API Developer Portal'in Apinizer Management API'lerini tüketebilmesi için gerekli olan token bilgisidir.

API_MANAGER_URL='<APINIZER_MANAGEMENT_API_BASE_URL>'

API_MANAGER_APIKEY='<API_KEY>'

echo -n ${API_MANAGER_URL} | base64
//Bunun çıktısını bir sonraki adımda <ENCODED_URL> değişkeni yerine koyacağız
 
echo -n ${API_MANAGER_APIKEY} | base64
//Bunun çıktısını bir sonraki adımda <ENCODED_API_KEY> değişkeni yerine koyacağız

vi api-portal-secret.yaml 

apiVersion: v1
kind: Namespace
metadata:
  name: apinizer-portal
---
apiVersion: v1
kind: Secret
metadata:
 name: apinizer-portal-secret
 namespace: apinizer-portal
type: Opaque
data:
  apinizerManagementApiBaseUrl: <ENCODED_URL>
  apiKey: <ENCODED_API_KEY> 

kubectl apply -f api-portal-secret.yaml

vi apinizer-portal-deployment.yaml 

apiVersion: apps/v1
kind: Deployment
metadata:
  name: apinizer-portal
  namespace: apinizer-portal
spec:
  replicas: 1
  selector:
    matchLabels:
      app: apinizer-portal
      version: v1
  template:
    metadata:
      labels:
        app: apinizer-portal
        version: v1
    spec:
      containers:
        - name: apinizer-portal-app
          image: apinizercloud/portal:<APINIZER_VERSION>
          env:
            - name: SPRING_PROFILES_ACTIVE
              value: prod
            - name: JAVA_OPTS
              value: '-XX:MaxRAMPercentage=75.0'
            - name: API_PORTAL_MANAGEMENT_API_BASE_URL
              valueFrom:
                secretKeyRef:
                  key: apinizerManagementApiBaseUrl
                  name: apinizer-portal-secret
            - name: API_PORTAL_MANAGEMENT_API_KEY
              valueFrom:
                secretKeyRef:
                  key: apiKey
                  name: apinizer-portal-secret
          resources:
            limits:
              memory: 2Gi
              cpu: 1
          ports:
            - name: http
              containerPort: 8080
---
apiVersion: v1
kind: Service
metadata:
  name: apinizer-portal-service
  namespace: apinizer-portal
  labels:
    app: apinizer-portal
spec:
  selector:
    app: apinizer-portal
  type: NodePort
  ports:
    - name: http
      port: 8080
      nodePort: <API_DEVELOPER_PORTAL_PORT>

kubectl apply -f apinizer-portal-deployment.yaml 

Önemli

Bu aşamaya kadar API Developer Portal arayüzü kurulumu yapılmış olabilir, ancak API'lerin API Developer Portal üzerinde görüntülenebilmesi, Credential'ların oluşturulması ve diğer yeteneklerin kullanılabilmesi için API Manager ile entegrasyonunun yapılması gerekmektedir.

3.3) API Developer Portal'in API Manager ile Entegrasyonu

API Manager'da, Portal → Ayarlar → Portal sayfasına giderek, kurumunuza uygun tanımları yapınız.

Detaylı bilgi için tıklayınız.

3.4) API Developer Portal'i SSL ile Başlatma

İstenilen durumlarda API Developer Portal SSL ile erişime açılabilir.

Detaylı bilgi için tıklayınız.

Yukarıdaki adımlar tamamlandıktan ve Kubernetes üzerinde API Portal'e ait olan Pod'ların hazır durumda olduğundan emin olduktan sonra, Portal Arayüzüne erişmek için aşağıdaki adresten erişim sağlanabilir.

http://<KUBERNETES_WORKER_IP>:<API_PORTAL_PORT>