Generating realistic example values
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- clojure, openapi
- Ambito
- api, documentation
Direzione di ricerca
Inizia tracciando come le definizioni di Prismatic Schema diventano valori di esempio per Swagger UI, quindi confronta questo percorso con il generatore personalizzato descritto usando test.check. L’issue è completa quando uno schema può fornire valori realistici che soddisfano i vincoli e tali valori compaiono negli esempi Swagger UI generati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Library Version(s)
1.1.11
Problem
I'm experimenting with compojure-api for documenting a new set of APIs with Prismatic Schema. It;s working well so far, though I have one issue which is not obvious how to resolve - how to generate realistic example values for an input / output schema.
Currently I get Example Values in the swagger UI like this:
{
"name": "string",
"description": "string",
"type": "assetClass1",
"ownerID": "string"
"dateCreated": "2018-11-19T01:25:04.282Z",
}
In this case, I need ownerID to be a 64 character hex string which satisfies a custom valid-user-id? predicate, which defined in Schema as something like:
(s/defschema UserID
(s/constrained s/Str valid-user-id? "Valid User ID"))
However it's not clear how to get compojure-api to generate valid values which satisfy the constraint (The value "string" doesn't....) and display these to the user in the Swagger UI.
Is there a way to do this? Ideally I would like to be able to specify a custom generator for the schema, which I build easily enough with test.check but how do I get that to be reflected in the Swagger UI?
Any help much appreciated!
- Lingua principale
- Clojure
- Stelle
- 1.1k
- Fork
- 145
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di metosin/compojure-api
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
metosin/compojure-api#489 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 30/100
metosin/compojure-api#468 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 20/100
metosin/compojure-api#467 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
metosin/compojure-api#464 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 30/100
metosin/compojure-api#463 · 3 commenti ·
Tutte le issue di metosin/compojure-api
Issue simili
-
.Needs Triage .Run Repro Bot .Team/UXWest Priority:P3 Type:Bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
metabase/metabase#84325 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
NoahTheDuke/splint#56 ·
-
Permissioned transactions fetch each entity once per tx-step, producing huge permission-check queriesForse già presa @verveguy l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 Mezza giornata Idoneità per principianti 84/100
clojure-lsp/clojure-lsp#2502 ·
I maintainer di solito rispondono entro 1 giorno
-
Sessions are never closedAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100