Creación de especificaciones OpenAPI personalizadas

Esta plantilla se puede utilizar para crear un nuevo archivo JSON de especificación swagger.
Tabla 1. Plantilla para el Swagger JSON de especificación
Nombre de campo Tipo Especificación
openapi string Obligatorio Esta serie debe ser el número de versión semántica de la versión de especificación OpenAPI que utiliza el documento OpenAPI. Los clientes y las especificaciones de herramientas deben utilizar el campo openapi para interpretar el documento OpenAPI. Esto no está relacionado con la cadena de API info.version.
info Objeto de información OBLIGATORIO Proporciona metadatos sobre la API. Las herramientas pueden utilizar los metadatos según sea necesario.
servidores [Objeto de servidor] Una matriz de objetos de servidor, que proporciona información de conectividad a un servidor de destino. Si la propiedad servers no se proporciona, o es una matriz vacía, el valor predeterminado sería un Objeto de servidor con un valor de URL de /.
vías de acceso Objeto de vías de acceso Obligatorio Las vías de acceso y las operaciones disponibles para la API.
componentes Objeto de componentes Elemento que contiene varios esquemas para la especificación.
security [Objeto de requisitos de seguridad] Declaración de qué mecanismos de seguridad se pueden utilizar en la API. La lista de valores incluye objetos de requisitos de seguridad alternativos que se pueden utilizar. Solo se debe satisfacer uno de los objetos de requisito de seguridad para autorizar una solicitud. Las operaciones individuales pueden anular esta definición. Para que la seguridad sea opcional, se puede incluir un requisito de seguridad vacío ({}) en la matriz.
códigos [Objetos de etiqueta] Una lista de etiquetas utilizadas por las especificaciones con metadatos adicionales El orden de las etiquetas se puede utilizar para reflejar su orden mediante las herramientas de análisis. No se deben declarar todas las etiquetas que utiliza el objeto de operación. Las etiquetas que no se declaran pueden organizarse de forma aleatoria o según la lógica de la herramienta. Cada nombre de etiqueta de la lista debe ser único.
externalDocs Objeto de documentación externa Documentación adicional externa