یک مشخصات OpenAPI ایجاد کنید

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات

در این آموزش، شما یک OpenAPI Specification برای مدل سازی API ایجاد می کنید که سرور هدف را فراخوانی می کند. سرور مورد نظر از یک سرور بسیار ساده مبتنی بر 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. API را با ارسال درخواست HTTP زیر تست کنید.

    curl localhost:3000/v1/hello

    API بازگشت: سلام جهان!

یک مشخصات OpenAPI ایجاد کنید

برای ایجاد یک OpenAPI Specification که API را مدل می کند که سرور Node.js را فراخوانی می کند.

  1. به apigee.com/edge وارد شوید.
  2. Develop > Specs را در نوار ناوبری کناری انتخاب کنید.
    لیست مشخصات نمایش داده می شود.

  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. روی ذخیره کلیک کنید.
    از شما خواسته می شود مشخصات را نام ببرید.

  7. یک نام برای مشخصات وارد کنید، مانند: simple-spec .

  8. روی Continue کلیک کنید.
    مشخصات ذخیره شده است.

  9. روی Close کلیک کنید تا مشخصات بسته شود و به لیست مشخصات برگردید.

مشخصات جدید در لیست مشخصات نمایش داده می شود.

بعد چه می شود؟

تبریک می گویم! شما اولین مشخصات OpenAPI خود را برای مدل سازی API ایجاد کرده اید که یک سرور هدف را فراخوانی می کند.

در مرحله بعد، نحوه ایجاد یک پروکسی API از مشخصات OpenAPI را بیاموزید.