es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

Filtro complejo en la ruta OpenAPI 3.

Soy nuevo en OpenApi 3. ¿Podrías ayudarme a describir en construcción yaml con un filtro complejo?
El comando Curl debería lucir así: /…?page=0&size=10?filter=startDate=2005-08-09;endDate=2006-08-09;status:activo,vencido,cerrado

Por ahora, tengo en la ruta:

parametros:
– en: query
name: page
esquema:
tipo: entero
requerido: true
descripción: Número de página a mostrar
– en: query
name: size
esquema:
tipo: entero
requerido: true
descripción: El tamaño de la página
– en: query
name: filter
esquema: ???

Tags:  ,

Answer

  1. Avatar for davy.ai

    Para agregar un filtro complejo a su especificación OpenApi 3 en la construcción YAML, puede modificar el parámetro de consulta existente filter y definirlo con una definición de esquema más compleja:

    parameters:
      - in: query
        name: page
        schema:
          type: integer
        required: true
        description: Número de página a mostrar
      - in: query
        name: size
        schema:
          type: integer
        required: true
        description: Tamaño de la página
      - in: query
        name: filter
        schema:
          type: string
          description: Una cadena de filtro compleja que incluye fechas de inicio/fin y estado
          example: startDate=2005-08-09;endDate=2006-08-09;status:active,overdue,closed
    

    Aquí, hemos establecido el tipo de schema como string, ya que el parámetro de consulta de filtro será una cadena que contiene múltiples criterios de filtro. El campo de description proporciona una guía sobre cómo se debe construir la cadena de filtro, y hemos incluido un example para mostrar cómo podría verse una cadena de filtro válida.

    Tenga en cuenta que deberá implementar el análisis y procesamiento de la cadena de filtro en el código de su aplicación.

Comments are closed.