openapi: 3.0.1
info:
title: API de consultório
description: Api para controlar médicos e especialidades dentro do consultório
version: "1"
termsOfService: https://mockapi.io
contact:
name: Suporte a Devs
email: contato@example.com
url: https://mockapi.io
license:
name: GPLv3
url: https://www.gnu.org/licenses/gpl-3.0.html
externalDocs:
description: Documentação burocrática
url: https://mockapi.io
servers:
- url: https://6096015d116f3f00174b29ba.mockapi.io/
description: API de Teste
paths:
/especialidades:
get:
summary: Recupera todas as especialidades
responses:
"200":
description: Sucesso
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
description:
type: string
post:
summary: Cria nova especialidade
description: Atraves desse endpoint você pode criar novas especialidades
requestBody:
content:
application/json:
schema:
type: object
properties:
descricao:
type: string
responses:
"201":
description: "Sucesso"
content:
application/json:
schema:
type: object
properties:
id:
type: integer
descricao:
type: string
/especialidades/{id}:
parameters:
- name: id
in: path
schema:
type: integer
required: true
get:
summary: Recupera uma entidade pelo ID
responses:
"200":
description: Sucesso
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description:
type: string
"404":
description: Especialidade não encontrata
content:
application/json:
example: "Not Found"
put:
summary: Atualiza uma entidade pelo ID
requestBody:
content:
application/json:
schema:
type: object
properties:
descricao:
type: string
responses:
"200":
description: Sucesso
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description:
type: string
"404":
description: Especialidade não encontrata
content:
application/json:
example: "Not Found"
delete:
summary: Deleta uma entidade pelo ID
responses:
"200":
description: Sucesso
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description:
type: string
"404":
description: Especialidade não encontrata
content:
application/json:
example: "Not Found"