OpenAPI স্পেসিফিকেশন তৈরি করা

আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন দেখুন। তথ্য

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

আপনি কী শিখবেন

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

আপনার কী প্রয়োজন হবে

শুরু করার জন্য আপনার যা যা প্রয়োজন:

একটি সাধারণ 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. প্রয়োজনীয় Express মডিউল ইনস্টল করুন:

    npm install express

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

    node index.js

    নিম্নলিখিত মেসেজটি ফেরত দেওয়া হয়:
    Example app listening on port 3000

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

    curl localhost:3000/v1/hello

    API রিটার্ন করে: হ্যালো ওয়ার্ল্ড!

OpenAPI স্পেসিফিকেশন তৈরি করা

Node.js সার্ভারকে কল করে এমন API-এর মডেল তৈরি করতে OpenAPI স্পেসিফিকেশন তৈরি করা।

  1. apigee.com/edge লিঙ্কে গিয়ে সাইন-ইন করুন।
  2. সাইড নেভিগেশন বার থেকে ডেভেলপ করুন > স্পেসিফিকেশন বিকল্প বেছে নিন।
    স্পেসিফিকেশনের তালিকা দেখানো হয়।

  3. + স্পেক বিকল্পে ক্লিক করে ড্রপ-ডাউন মেনু থেকে নতুন স্পেক বিকল্প বেছে নিন।

  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. স্পেসিফিকেশন বন্ধ করতে বন্ধ করুন বিকল্পে ক্লিক করুন এবং স্পেসিফিকেশন তালিকায় ফিরে যান।

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

এরপর কি আছে?

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

এরপরে, OpenAPI স্পেসিফিকেশন থেকে কীভাবে API প্রক্সি তৈরি করতে হয় তা জানুন।