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

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

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

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

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

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

শুরু করতে আপনার যা প্রয়োজন তা এখানে:

একটি সাধারণ 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

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

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

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

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

  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. Save এ ক্লিক করুন।
    আপনাকে স্পেসিফিকেশনের নাম দিতে বলা হবে।

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

  8. অবিরত ক্লিক করুন.
    স্পেসিফিকেশন সংরক্ষণ করা হয়.

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

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

পরবর্তী কি?

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

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