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

    npm install express

  5. سرور را شروع کنید:

    node index.js

    پیام زیر برگردانده می‌شود:
    Example app listening on port 3000

  6. با ارسال درخواست HTTP زیر، API را آزمایش کنید.

    curl localhost:3000/v1/hello

    API برمی‌گرداند: سلام دنیا!

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

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

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

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

قدم بعدی چیست؟

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

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