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

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

در این آموزش گام‌به‌گام، «مشخصات OpenAPI» را برای مدل‌سازی میانای برنامه‌سازی کاربردی که سرور هدف را فراخوانی می‌کند ایجاد می‌کنید. سرور هدف از سرور بسیار ساده‌ای مبتنی بر Node.js تشکیل شده است که آن را در دستگاهتان ایجاد و اجرا می‌کنید. تکمیل این آموزش حدود ۱۰ دقیقه طول می‌کشد.

آنچه خواهید آموخت

در این آموزش، با نحوه انجام این کارها آشنا می‌شوید:

آنچه نیاز خواهید داشت

برای شروع، به این موارد نیاز دارید:

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

    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» خود را برای مدل‌سازی میانای برنامه‌سازی کاربردی که سرور هدف را فراخوانی می‌کند ایجاد کرده‌اید.

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