Can't get Swagger UI to provide interface for arbitrary query params
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- clojure, openapi
- Área
- api, documentation
Línea de trabajo
Comienza con la ruta GET "/find" y su declaración :query; después, inspecciona cómo compojure-api convierte mapas de consulta arbitrarios en la descripción de OpenAPI/Swagger. Se considera terminado cuando Swagger UI puede emitir ?a=1\u0026b=2 para claves elegidas por el requester, mientras el handler existente recibe el mapa; verifícalo con los ejemplos de curl.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Library Version(s)
2.0.0-alpha31
Problem
Swagger can display a UI for setting dynamic query parameters, but I can't figure out how to do it with compojure-api.
I have a /find endpoint which needs to receive arbitrary query parameters.
E.g., Given /api/find?x=1&y=2&z=3 I want to receive a map {:x 1, :y 2, :3} somewhere in my handler. The keys are chosen by the requester.
(ns myns (:require [schema.core :as scm]))
(def myapp
(api ...
(GET "/find" [& fields]
:return scm/Any
(ok fields))
This works:
curl 'localhost:8080/api/runs/find?a=1&b=2'
{"a":"1","b":"2"}%
But the Swagger UI does not provide a way to set the query parameters:
I've tried variants of the route, providing
:query [fields scm/Any]
And many other things. I can't seem to find documentation for the arguments to :query. (Also, does anyone understand what :- is for?)
If I use a schema that starts with schema.core/maybe...
(scm/defschema QueryArgs (scm/maybe (scm/cond-pre scm/Num scm/Str scm/Bool scm/Keyword scm/Uuid)))
and provide this to :query...
(GET "/find" [& fields]
:return scm/Any
:query [fields QueryArgs]
(ok))
Swagger at least shows a box that allows me to assign several values inside another parameter, but it's not the one I want:
It produces a URL like this:
curl -X GET --header 'Accept: application/json' 'http://localhost:8080/api/runs/find?schemas=a%3D1&schemas=b%3D2'
But I want
curl -X GET --header 'Accept: application/json' 'http://localhost:8080/api/runs/find?a=1&b=2'
- Lenguaje dominante
- Clojure
- Estrellas
- 1.1k
- Forks
- 145
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de metosin/compojure-api
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
metosin/compojure-api#489 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
metosin/compojure-api#468 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
metosin/compojure-api#467 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
metosin/compojure-api#464 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
metosin/compojure-api#463 · 3 comentarios ·
Todos los issues de metosin/compojure-api
Issues similares
-
Dificultad 2/5 Medio día Aptitud para principiantes 84/100
clojure-lsp/clojure-lsp#2502 ·
Los mantenedores suelen responder en 1 día
-
Sessions are never closedAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
category:tooling
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día