OpenAPI Spesifikasyonu oluştur

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Bu eğitimde, hedef sunucuyu çağıran bir API'yi modellemek için OpenAPI Specification oluşturacaksınız. Hedef sunucu, makinenizde oluşturup çalıştırdığınız çok basit bir Node.js tabanlı sunucudan oluşur. Bu eğitimin tamamlanması yaklaşık 10 dakika sürer.

Neler öğreneceksiniz?

Bu eğitimde şunları öğreneceksiniz:

• Basit bir Node.js sunucusu oluşturma
• Node.js sunucusunu çağıran bir API'yi modelleyen bir OpenAPI spesifikasyonu oluşturun .

İhtiyacınız olanlar

Başlamak için gerekenler:

• Apigee Edge hesabı (bkz. Apigee Edge hesabı oluşturma)
• Node.js'nin son sürümü
• curl komut satırı aracı
• Metin düzenleyici

Basit bir Node.js sunucusu oluşturma

Basit bir Node.js sunucusu oluşturmak için:

1. index.js adlı bir dosya oluşturun.

2. Aşağıdaki Node.js kodunu dosyaya kopyalayın:

   var express = require('express');
   var app = express();  
   
   app.get('/v1/hello', function (req, res) {
     res.setHeader("Access-Control-Allow-Origin", "*");
     res.send('Hello World!\n');
   });  
   
   app.listen(3000, function () {
     console.log('Example app listening on port 3000!');
   });
   

3. Dosyayı kaydedin.

4. Gerekli Express modülünü yükleyin:

   npm install express

5. Sunucuyu başlatın:

   node index.js

   Aşağıdaki mesaj döndürülür:
   Example app listening on port 3000

6. Aşağıdaki HTTP isteğini göndererek API'yi test edin.

   curl localhost:3000/v1/hello

   API şu değeri döndürür: Hello World!

OpenAPI spesifikasyonu oluşturma

Node.js sunucusunu çağıran API'yi modelleyen bir OpenAPI Specification oluşturmak için.

1. apigee.com/edge adresinde oturum açın.
2. Yan gezinme çubuğunda Geliştir > Spesifikasyonlar'ı seçin.
   Özellikler listesi gösterilir.

3. + Spec'i tıklayın ve açılır menüden New Spec'i (Yeni Spec) seçin.

4. Aşağıdaki YAML içeriğini kopyalayın:

   swagger: "2.0"
   info:
     version: "0.0.1"
     title: Hello World API
   host: 127.0.0.1:3000
   basePath: /v1
   schemes:
     - http
   consumes:
    - application/json
   produces:
     - application/json
   paths:
     '/hello':
       get:
         description: Returns greetings to the caller
         operationId: hello
         responses:
           "200":
             description: Success
             schema:
               $ref: "#/definitions/HelloWorldResponse"
           default:
             description: Error
             schema:
               $ref: "#/definitions/ErrorResponse"
   definitions:
     HelloWorldResponse:
       required:
         - message
       properties:
         message:
           type: string
         age:
           type: number
     ErrorResponse:
       required:
         - message
       properties:
         message:
           type: string
   

5. YAML içeriğini düzenleyicinin sol bölmesine yapıştırın (mevcut içeriğin üzerine yazarak).

6. Kaydet'i tıklayın.
   Spesifikasyonu adlandırmanız istenir.

7. Şartname için bir ad girin (ör. simple-spec).

8. Devam'ı tıklayın.
   Şartname kaydedilir.

9. Şartnameyi kapatmak ve şartname listesine geri dönmek için Kapat'ı tıklayın.

Yeni spesifikasyon, spesifikasyon listesinde gösterilir.

Sırada ne var?

Tebrikler! Hedef sunucuyu çağıran bir API'yi modellemek için ilk OpenAPI spesifikasyonunuzu oluşturdunuz.

Ardından, OpenAPI Specification'dan API proxy'si oluşturmayı öğrenin.