Middle+
Foi necessário projetar uma API? Utilizou OpenAPI, Swagger?
sobes.tech IA
Resposta da IA
Sim, tive que projetar API. Para descrever e documentar API RESTful, utilizei a Especificação OpenAPI (anteriormente conhecida como Swagger). Isto permite formalizar a estrutura da API, descrever os endpoints, métodos, parâmetros e modelos de dados, bem como gerar automaticamente documentação e SDKs de cliente.
Exemplo de uma descrição simples de um endpoint em OpenAPI (YAML):
paths:
/users:
get:
summary: Obter lista de utilizadores
responses:
'200':
description: Resposta bem-sucedida
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
components:
schemas:
User:
type: object
properties:
id:
type: integer
name:
type: string