Swagger date-time format

Ejemplo de matriz Swagger

Mi API web tiene valores de fecha y hora con un formato especificado como este "1975-12-10 12:11:20". Los valores datetime están formateados como hora local sin información de zona horaria. No estoy muy seguro de cómo poner esto en el swagger. Esto es lo que tengo hasta ahora, pero no estoy seguro de que sea correcto. En cualquier caso, el editor swagger no muestra mi formato esperado para los valores:

@rycler Supongo que cuando dices que usas swagger para construir el controlador del lado del servidor, te refieres a swagger-codegen. Si ese es el caso, entonces el error está en el codegen ya que debería interpretar date-time como capaz de aceptar noly la muestra de salida que has proporcionado. Si no es el caso, entonces el bug debería abrirse en el codegen donde debería añadirse esa restricción.

Lista de objetos Openapi

Aunque OffsetDateTime es probablemente la opción por defecto correcta para la fecha-hora de swagger, LocalDateTime es semánticamente correcto en algunos casos y, por tanto, debería estar disponible como opción. Como ejemplo, imagine que tiene un buque que viaja entre diferentes zonas horarias (caso muy común en la industria naviera).

Las fechas con desfase horario local siempre representan los mismos instantes en el tiempo y, por tanto, tienen un orden estable. Por el contrario, el significado de las fechas con información completa de la zona horaria es inestable frente a los ajustes de las reglas de las respectivas zonas horarias.

Esta clase almacena todos los campos de fecha y hora, con una precisión de nanosegundos, así como el desfase respecto a UTC/Greenwich. Por ejemplo, el valor 2 de diciembre de 2018 a las 15:35.40.123456789 +03:00 puede almacenarse en una OffsetDateTime. Por otro lado, LocalDateTime representa una fecha y hora sin información de zona horaria.

Swagger Codegen es un proyecto de código abierto que permite generar bibliotecas de cliente de API (generación de SDK), stubs de servidor y documentación automáticamente a partir de una especificación OpenAPI. Swagger Codegen está disponible para su descarga en el repositorio GitHub, o puede generarse para cualquier API nueva o existente definida por OpenAPI en la plataforma integrada SwaggerHub.

Matriz de objetos Swagger

Issue AnalyticsTop GitHub Comments2reactionsmtennocommented, Mar 11, 2020Podríamos considerar hacer la unión de cadenas como una solución provisional compatible con versiones anteriores, y luego eliminar la parte | cadena al pasar a la siguiente versión principal.

La compatibilidad con versiones anteriores es importante, por lo que podríamos considerar una solución que expone un tipo de unión para las fechas, donde el tipo sería Fecha | cadena, y entonces podríamos comprobar qué tipo se pasa en el lado de la persona que llama. En cualquier caso, la llamada contendría una versión de cadena de la fecha. De esta forma se mantendría la compatibilidad con versiones anteriores, al tiempo que se facilitaría la tarea a los usuarios/consumidores, que no tendrían que realizar manualmente la conversión de la fecha en cadena.

Swagger timestamp

Las palabras clave "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", y "OPTIONAL" en este documento deben interpretarse como se describe en BCP 14 RFC2119 RFC8174 cuando, y sólo cuando, aparecen en mayúsculas, como se muestra aquí.

La Especificación OpenAPI (OAS) define una interfaz estándar e independiente del idioma para las API HTTP que permite tanto a humanos como a ordenadores descubrir y comprender las capacidades del servicio sin acceso al código fuente, la documentación o a través de la inspección del tráfico de red. Cuando se define correctamente, un consumidor puede entender e interactuar con el servicio remoto con una cantidad mínima de lógica de implementación.

Una definición OpenAPI puede ser utilizada por herramientas de generación de documentación para mostrar la API, herramientas de generación de código para generar servidores y clientes en varios lenguajes de programación, herramientas de prueba y muchos otros casos de uso.

Un recurso autónomo o compuesto que define o describe una API o elementos de una API. El documento OpenAPI DEBE contener al menos un campo de rutas, un campo de componentes o un campo de webhooks. Un documento OpenAPI utiliza y se ajusta a la Especificación OpenAPI.