Forum Discussion

frankmehlhop's avatar
frankmehlhop
New Contributor
6 years ago

How to set default values into Swagger form

Hi, I have a Swagger ui and a C# Controller with a GET. Tha GET need's a json File as atribute. Each time I will test my Api I have to write surtain values into the form (json). Because it is a...
Swagger Editor
Swagger UI
ralphdoe's avatar
ralphdoe
New Contributor

Hi Frank.

 

I think you need to use the example property. 

parameters:
  - in: query
    name: status
    schema:
      type: string
      enum: [approved, pending, closed, new]
      example: approved

 

You can find more information in this link:

https://swagger.io/docs/specification/adding-examples/

 

Have a nice day. 

frankmehlhop's avatar
frankmehlhop
New Contributor
6 years ago

Thanks for your Reply!
But I'm not looking for examples, I'm looking for default values.
This I find here: https://swagger.io/docs/specification/describing-parameters/
And also I have no idea how to implement this (also this linked example with exaples) in the C# Rest Api controller.

Frank

 

This code don't work:

        [HttpGet()]
        [Get /MetaDataRequest?ResourceID='123'] // That's wrong. But I do it right?
        public IActionResult Get(MetaDataRequest json)
        { ...