Olá galera, surgiu uma duvida.
por exemplo tem uma entrada 2024-07, ano e mês, nesse cenário, devo colocar o type: string e format: "YYYY-MM" ?
Você está vendo a versão anterior da nova experiência da Alura que estamos preparando para você. Em breve, ela ganha uma identidade visual novinha totalmente pensada em potencializar seus estudos!
Olá galera, surgiu uma duvida.
por exemplo tem uma entrada 2024-07, ano e mês, nesse cenário, devo colocar o type: string e format: "YYYY-MM" ?
Oi, Williams! Tudo bem?
Para representar uma data no formato "YYYY-MM" no Swagger, devemos de fato utilizar o type: string. No entanto, o format deve ser date ou date-time conforme os formatos padrão suportados pelo Swagger (OpenAPI). Infelizmente, o Swagger não possui um formato específico para "YYYY-MM", porém podemos definir o campo assim:
parameters:
- name: date
in: query
required: true
schema:
type: string
pattern: '^\d{4}-(0[1-9]|1[0-2])$'
example: '2024-07'
Aqui, a propriedade pattern usa uma expressão regular para garantir que a string siga o formato "YYYY-MM". O example fornece um exemplo válido para ajudar na documentação.
Espero ter ajudado!
Um forte abraço e bons estudos!