एक 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. ज़रूरी Express मॉड्यूल इंस्टॉल करें:

    npm install express

  5. सर्वर को चालू करने के लिए:

    node index.js

    यह मैसेज मिला:
    Example app listening on port 3000

  6. एपीआई की जांच करने के लिए, नीचे दिया गया एचटीटीपी अनुरोध भेजें. 

    curl localhost:3000/v1/hello

    एपीआई यह दिखाता है: नमस्ते दुनिया के लोगों!

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. वाईएएमएल कॉन्टेंट को एडिटर के बाएं पैनल में चिपकाएं. इससे मौजूदा कॉन्टेंट ओवरराइट हो जाएगा.

  6. सेव करें पर क्लिक करें.
    आपको स्पेसिफ़िकेशन का नाम देने के लिए कहा जाएगा.

  7. स्पेसिफ़िकेशन के लिए कोई नाम डालें, जैसे कि: simple-spec.

  8. जारी रखें पर क्लिक करें.
    स्पेसिफ़िकेशन सेव हो जाता है.

  9. स्पेसिफ़िकेशन को बंद करने और स्पेसिफ़िकेशन की सूची पर वापस जाने के लिए, बंद करें पर क्लिक करें.

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

अगला चरण?

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

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