Criar uma especificação OpenAPI

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Neste tutorial, você vai criar uma especificação OpenAPI para modelar uma API que chama um servidor de destino. O servidor de destino consiste em um servidor muito simples baseado em Node.js que você cria e executa na sua máquina. Este tutorial leva cerca de 10 minutos para ser concluído.

O que você vai aprender

Neste tutorial, você vai aprender a:

O que é necessário

Para começar, você vai precisar do seguinte:

Criar um servidor Node.js simples

Para criar um servidor Node.js simples:

  1. Crie um arquivo chamado index.js.

  2. Copie o seguinte código Node.js no arquivo:

    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. Salve o arquivo.

  4. Instale o módulo Express necessário:

    npm install express

  5. Inicie o servidor:

    node index.js

    A seguinte mensagem é retornada:
    Example app listening on port 3000

  6. Teste a API enviando a seguinte solicitação HTTP. 

    curl localhost:3000/v1/hello

    A API retorna: Hello World!

Criar uma especificação OpenAPI

Criar uma especificação OpenAPI que modele a API que chama o servidor Node.js.

  1. Faça login em apigee.com/edge.
  2. Selecione Desenvolver > Especificações na barra de navegação lateral.
    A lista de especificações é exibida.

  3. Clique em + Especificação e selecione Nova especificação no menu suspenso.

  4. Copie o seguinte conteúdo 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. Cole o conteúdo YAML no painel esquerdo do editor, substituindo o conteúdo atual.

  6. Clique em Salvar.
    Será preciso nomear a especificação.

  7. Insira um nome para a especificação, como simple-spec.

  8. Clique em Continuar.
    A especificação é salva.

  9. Clique em Fechar para fechar a especificação e voltar à lista.

A nova especificação é exibida na lista.

A seguir

Parabéns! Você criou sua primeira especificação OpenAPI para modelar uma API que chama um servidor de destino.

Em seguida, saiba como criar um proxy de API com base em uma especificação OpenAPI.