एक 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

    एपीआई यह जवाब देता है: Hello World!

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

Node.js सर्वर को कॉल करने वाले एपीआई को मॉडल करने के लिए, 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. स्पेसिफ़िकेशन को बंद करने और स्पेसिफ़िकेशन की सूची पर वापस जाने के लिए, बंद करें पर क्लिक करें.

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

अगला चरण?

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

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