Pular para o conteúdo principal

OpenAPI

Introdução​

OpenAPI é uma especificação que padroniza os serviços que são oferecidos pelas APIs REST, ajuda a entender como os serviços estão definidos, como endereço, inputs e outputs.

Permite a geração de interface de testes e geração automática de clientes para ser integrado com outras tecnologias.

Mais sobre OpenAPI.

Ativação e Configuração​

Para ativar e configurar a OpenAPI na sua aplicação no Netuno é necessário editar o ficheiro de configuração da aplicação referente ao ambiente que está a utilizar, como:

  • 📂 config/_development.json
  • 📂 config/_production.json

Insira e ajuste os seguintes parâmetros:

...
    "openapi": {
        "host": "http://minha-app.local.netu.no:9000",
        "basePath": "/services",
        "schemes": [ "http" ],
        "servers": [
            {
                "url": "http://minha-app.local.netu.no:9000/services",
                "description": "Desenvolvimento Local"
            }
        ]
    },
...

Certifique que as configurações fazem sentido, no exemplo acima é para o ambiente de development.

Em produção, convém utilizar https.

_openapi.json nos Serviços​

Na raíz dos serviços, configure o ficheiro _openapi.json.

O caminho completo dentro da aplicação é:

  • 📂 server/services/_openapi.json

O conteúdo deste ficheiro será como este exemplo:

{
  "info": {
    "title": "Minha Aplicação",
    "description": "REST API da Minha Aplicação utilize com Moderação.",
    "version": "1.0"
  },
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}

Ajuste o título e a descrição para o que faz sentido no seu caso.

Input​

Ao configurar ficheiros schema de inputs, permite ao Netuno realizar a validação dos parâmetros recebidos ao compará-los com as regras do JSON Schema.

Mais sobre o JSON Schema.

Caso haja alguma falha na validação é impedida a execução do serviço e é apresentado um erro no log do Netuno e, para quem consome o serviço é retornado o HTTP Status Code 400 (Bad Request).

Para configurar as regras dos parâmetros de input é necessário criar um ficheiro com a extensão in.json junto ao ficheiro de código do serviço, o nome deve ser o mesmo.

  • O serviço detalhe.js teria que ter o ficheiro detalhe.in.json.
  • O serviço detalhe.post.js teria que ter o ficherio detalhe.post.in.json.
  • O serviço detalhe/post.js teria que ter o ficherio detalhe/post.in.json.

Exemplo de conteúdo do in.json:

{
    "tags":[
      "serviços de produto"
    ],
    "summary": "Detalhe do Produto",
    "description": "É obtido todos os campos de detalhe do produto especificado.",
    "type": "object",
    "properties": {
      "uid": {
        "type": "uid"
      }
    },
    "required": [
      "uid"
    ]
}

O Netuno tem o suporte de alguns tipos adicionais que não são suportados pelo JSON Schema, como string-not-empty, array-not-empty, id e o uid (ou uuid ou ainda guid).

Mais sobre esta especificação em JSON Schema Learn.

Output​

Ao configurar ficheiros schema de outputs, permite ao Netuno realizar a validação dos parâmetros enviados ao compará-los com as regras do JSON Chema.

Mais sobre o JSON Schema.

Caso haja alguma falha na validação o output é enviado na mesma para quem consome o serviço mas, as mensagens de falhas de validação são apresentadas no log do Netuno.

Para configurar as regras dos parâmetros de output é necessário criar um ficheiro com a extensão out.200.json junto ao ficheiro de código do serviço, o nome deve ser o mesmo do serviço.

Onde o 200 é o HTTP Status Code que vai na resposta, para suportar múltiplos HTTP Status Code basta acrescentar mais ficheiros JSON com o número diferente.

Alguns exemplos:

  • O serviço guardar.js teria que ter o ficheiro guardar.out.200.json.
  • O serviço guardar.post.js teria que ter o ficherio guardar.post.out.200.json.
  • O serviço guardar/post.js teria que ter o ficherio guardar/post.out.200.json.

Exemplo de conteúdo do out.200.json:

{
    "type": "object",
    "properties": {
      "result": {
        "type": "boolean"
      }
    },
    "required": [
      "result"
    ]
}

O Netuno tem o suporte de alguns tipos adicionais que não são suportados pelo JSON Schema, como string-not-empty, array-not-empty, id e o uid (ou uuid ou ainda guid).

Mais sobre esta especificação em JSON Schema Learn.

Importação de Schema​

O Netuno suporta importar schemas, o que permite reutilizar parte do schema em múltipos JSONs.

Ao importar schemas evita repetição de código.

Crie a pasta _schema na raíz da pasta dos serviços, em:

  • 📂 server/services/_schema

Agora na configuração do JSON é possível importar schemas com o parâmetro _schema no JSON, por exemplo:

{
    "summary": "Apagar Produtos",
    "description": "Permite eliminar definitivamente produtos.",
    "_schema": "get/only-code.in"
}

Isto quer dizer que vai ser importado o ficheiro _schema/get/only-code.in.json onde está o parâmetro _schema.

Especificação e Testes​

Para gerar a especificação completa de todos os serviços que suportam OpenAPI com JSON Schema, acesse por exemplo:

Vai ser apresentado um JSON com toda a especificação.

Para testar, copie todo o JSON gerado.

Abra o Editor do Swagger: https://editor.swagger.io/

Apague o conteúdo que houver do lado esquerdo e cole o JSON e, responda sim na pergunta de conversão de JSON para YAML.

Com a interface gerada do lado direito é possível entender melhor todos os serviços disponíveis e realizar testes.

Também permite gerar automaticamente clientes para outras tecnologias.

Conclusão​

Com o suporte da OpenAPI podemos criar regras de validação utilizando o JSON Schema, o que oferece as seguintes vantagens:

  • Garantir maior segurança dos dados que são injetados nos serviços.
  • Alerta em log caso o output do serviço não seja como foi especificado.
  • Gera facilmente uma interface de navegação nos serviços e de testes.