2016-08-03 2 views
1

Ich muss entweder:Versteckte oder unveränderbare Parameter für meine API in Swagger-UI erstellen?

A) einen versteckten Parameter erstellen, die bei jedem Aufruf erzeugt aus meiner Swagger-UI-Schnittstelle zu meiner API (dh Test = true)

OR

B geleitet wird,) Setzen Sie den Parameter 'test' in der Benutzeroberfläche frei, setzen Sie ihn jedoch standardmäßig auf 'true' und lassen Sie KEINE Änderungen zu.

Wie kann einer von beiden von Swagger-UI erreicht werden?

+0

Was ist der Zweck davon? Es scheint rückwärts zu sein. Alle Parameter müssen in der API gesteuert werden, nicht in Prahlerei. Sobald ich Zugriff auf Ihre API habe, kann ich die Dinge sowieso nur noch außerhalb von swagger einreichen. –

+0

@DigitalChris stimme voll und ganz zu. Die API schreibt Daten in eine Tabelle in Mongo und ich möchte in der Lage sein, die "Test" -Anfragen, die von der Swagger-Benutzeroberfläche generiert werden, im Vergleich zu den echten Anfragen, die von Apps kommen, einfach auszusondern. Das ist der Zweck dahinter. – K997

Antwort

3

Erzwungene UI "test" als wahr mit enum und erforderlich true; Nur erzwungen, wenn Typ Integer oder String ist. Boolean wird automatisch Liste wahr und falsch zu der Dropdown-

YAML:

parameters: 
    - name: test 
     description: Test environment 
     required: true 
     type: string 
     in: query 
     enum: 
     - True 

Json:

"name":"test", 
"description": "Test environment", 
"required": true, 
"type":"string", 
"in":"query", 
"enum":["true"] 
+0

Das ist es, danke! – K997

Verwandte Themen