एक 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. यह एचटीटीपी अनुरोध भेजकर, इस एपीआई की जांच करें. 

    curl localhost:3000/v1/hello

    एपीआई दिखाता है: Hello World!

OpenAPI स्पेसिफ़िकेशन बनाना

एक OpenAPI स्पेसिफ़िकेशन बनाने के लिए, जो Node.js सर्वर को कॉल करने वाले एपीआई को मॉडल करता है.

  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. खास जानकारी को बंद करने और खास जानकारी की सूची पर वापस जाने के लिए, बंद करें पर क्लिक करें.

नई जानकारी, खास जानकारी की सूची में दिखाई गई है.

अगला चरण?

बधाई! आपने एक ऐसे एपीआई को मॉडल करने के लिए अपना पहला OpenAPI स्पेसिफ़िकेशन बनाया है जो टारगेट सर्वर को कॉल करता है.

इसके बाद, OpenAPI स्पेसिफ़िकेशन की मदद से एपीआई प्रॉक्सी बनाने का तरीका जानें.