API Calculadora com Swagger

Neste artigo vamos aprender como criar uma API de uma calculadora utilizando o Swagger.

Para quem não sabe, o Swagger é uma linguagem de descrição de interface para descrever APIs RESTful expressas usando JSON. O Swagger é usado junto com um conjunto de ferramentas de software de código aberto para projetar, construir, documentar e usar serviços da Web RESTful.

Para iniciarmos o projeto vamos ciar um diretório, onde pretendemos criar a nossa API. De seguida, no cmd, vamos abrir essa pasta e executar o comando:

npm init

Ficamos com o seguinte output:

Vamos agora executar o seguinte comando:

npm i -s swagger-jsdoc express  swagger-ui-express nodemon cors

Vamos executar o seguinte comando para criar um ficheiro index.js:

type nul >> index.js

Abrimos esse ficheiro com o Visual Studio Code (ou com outro editor de texto), e vamos inserir o seguinte código:

Agora, vamos criar uma pasta “routes” (dentro do diretório do projeto), e dentro da pasta “routes” vamos criar um ficheiro “calculadora.js”.
Dentro desse ficheiro, vamos inserir o seguinte código:

Este código permite a nossa API fazer as operações matemáticas básicas (soma, subtração, divisão e multiplicação).

Prosseguindo com o tutorial, vamos abrir o ficheiro “package.json” com o Visual Studio Code, e vamos escolher a nossa versão do “swagger-jsdoc”. Vamos escolher a versão 6.1.0:

Voltando ao cmd, vamos executar o seguinte comando:

npm i -s swagger-jsdoc

Vamos agora dar inicio ao nosso servidor através do nosso comando:

node index.js

Abrimos o browser e inserimos o seguinte link: http://localhost:3031/api-docs/#/ .

Vamos testar:

Soma:

Subtração:

Divisão:

Multiplicação:

Através dos prints, podemos verificar que as operações estão corretas e está tudo a funcionar corretamente!!