Generating realistic example values
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- clojure, openapi
- Bereich
- api, documentation
Rechercherichtung
Beginne damit nachzuverfolgen, wie Prismatic Schema-Definitionen zu Beispielwerten für Swagger UI werden, und vergleiche diesen Pfad anschließend mit dem mithilfe von test.check beschriebenen benutzerdefinierten Generator. Das Issue ist abgeschlossen, wenn ein Schema realistische Werte liefern kann, die die Constraints erfüllen, und diese Werte in den generierten Swagger UI-Beispielen erscheinen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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!
- Vorherrschende Sprache
- Clojure
- Sterne
- 1.1k
- Forks
- 145
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus metosin/compojure-api
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100
metosin/compojure-api#489 ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100
metosin/compojure-api#468 ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100
metosin/compojure-api#467 ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
metosin/compojure-api#464 ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100
metosin/compojure-api#463 · 3 Kommentare ·
Alle Issues in metosin/compojure-api
Ähnliche Issues
-
.Needs Triage .Run Repro Bot .Team/UXWest Priority:P3 Type:Bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
metabase/metabase#84325 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
NoahTheDuke/splint#56 ·
-
Permissioned transactions fetch each entity once per tx-step, producing huge permission-check queriesEvtl. vergeben @verveguy hat das vor 1 Tag übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 84/100
clojure-lsp/clojure-lsp#2502 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100