একটি OpenAPI স্পেসিফিকেশন তৈরি করুন

আপনি Apigee Edge-এর ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন .info- তে যান।

এই টিউটোরিয়ালে, আপনি একটি টার্গেট সার্ভারকে কল করে এমন একটি এপিআই মডেল করার জন্য একটি ওপেনএপিআই স্পেসিফিকেশন তৈরি করবেন। টার্গেট সার্ভারটি হলো একটি খুব সাধারণ নোড.জেএস-ভিত্তিক সার্ভার, যা আপনি আপনার মেশিনে তৈরি করে চালাবেন। এই টিউটোরিয়ালটি সম্পূর্ণ করতে প্রায় ১০ মিনিট সময় লাগে।

আপনি যা শিখবেন

এই টিউটোরিয়ালে আপনি শিখবেন কীভাবে:

আপনার যা যা লাগবে

শুরু করার জন্য আপনার যা যা প্রয়োজন হবে তা নিচে দেওয়া হলো:

একটি সাধারণ Node.js সার্ভার তৈরি করুন

একটি সাধারণ Node.js সার্ভার তৈরি করতে:

  1. index.js নামে একটি ফাইল তৈরি করুন।

  2. নিম্নলিখিত Node.js কোডটি ফাইলটিতে কপি করুন:

    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. ফাইলটি সংরক্ষণ করুন।

  4. প্রয়োজনীয় এক্সপ্রেস মডিউলটি ইনস্টল করুন:

    npm install express

  5. সার্ভার চালু করুন:

    node index.js

    নিম্নলিখিত বার্তাটি ফেরত আসে:
    Example app listening on port 3000

  6. নিম্নলিখিত HTTP অনুরোধটি পাঠিয়ে API-টি পরীক্ষা করুন।

    curl localhost:3000/v1/hello

    এপিআইটি ফেরত দেয়: হ্যালো ওয়ার্ল্ড!

একটি ওপেনএপিআই স্পেসিফিকেশন তৈরি করুন

যে এপিআইটি Node.js সার্ভারকে কল করে, তার মডেল হিসেবে একটি OpenAPI স্পেসিফিকেশন তৈরি করা।

  1. apigee.com/edge- এ সাইন ইন করুন।
  2. সাইড নেভিগেশন বার থেকে Develop > Specs নির্বাচন করুন।
    স্পেসিফিকেশনের তালিকাটি প্রদর্শিত হয়।

  3. + Spec-এ ক্লিক করুন এবং ড্রপ-ডাউন মেনু থেকে New Spec নির্বাচন করুন।

  4. নিম্নলিখিত YAML বিষয়বস্তু কপি করুন:

    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 কন্টেন্টটি পেস্ট করুন (বর্তমান কন্টেন্টটি ওভাররাইট করে)।

  6. সংরক্ষণ করুন- এ ক্লিক করুন।
    আপনাকে স্পেসিফিকেশনটির নাম দিতে বলা হবে।

  7. স্পেসিফিকেশনটির জন্য একটি নাম লিখুন, যেমন: simple-spec ।

  8. চালিয়ে যান-এ ক্লিক করুন।
    স্পেসিফিকেশনটি সংরক্ষিত হয়েছে।

  9. স্পেসিফিকেশনটি বন্ধ করতে এবং স্পেসিফিকেশন তালিকায় ফিরে যেতে ক্লোজ-এ ক্লিক করুন।

নতুন স্পেসিফিকেশনটি স্পেসিফিকেশন তালিকায় প্রদর্শিত হয়।

এরপর কী?

অভিনন্দন! আপনি একটি টার্গেট সার্ভারকে কল করে এমন একটি এপিআই মডেল করার জন্য আপনার প্রথম ওপেনএপিআই স্পেসিফিকেশন তৈরি করেছেন।

এরপর, একটি OpenAPI স্পেসিফিকেশন থেকে কীভাবে এপিআই প্রক্সি তৈরি করতে হয় তা শিখে নিন।