Empresas
Empleos
  • Sobre nosotros
  • Soluciones
    • Publicación de vacantes
      Publica tu vacante y recibe candidatos calificados en 48h.
    • Evaluación de candidatos
      500+ pruebas técnicas y psicológicas, más anti-fraude.
    • Headhunting
      Búsqueda ejecutiva a la medida de principio a fin.
    • Nómina + EOR
      Dispersión de nómina y EOR en más de 15 países de LATAM.
  • Precios
  • Empleos

0

240
Vistas
Swagger shows 'string' instead of body example

I am trying to set a default json body for the following endpoint:

const loginJsonSchema = {
    'type': 'object',
    'properties': {
        'username': {
            'type': 'string',
            'example': 'my_user' // this property is ignored
        },
        'password': {
            'type': 'string',
            'example': 'my_password' // this property is ignored
        },
    },
    'required': ['username', 'password'],
}


const paths = {
    "/auth/login": {
        "post": {
            "tags": [
                "auth"
            ],
            "summary": "Login",
            "description": "",
            "operationId": "auth-login",
            "consumes": [
                "application/json"
            ],
            "parameters": [
                {
                    "name": "Credentials",
                    "in": "body",
                    "description": "Your credentials",
                    "required": true,
                    "schema": {
                        loginJsonSchema
                    }
                }
            ],
            "responses": {
                "200": {
                    "description": "successful operation",
                    "schema": loginSuccessResponseSchema,
                },
            },
        }
    },

Instead of the example values, I get the default body as 'string':

enter image description here

I expected the following default body:

{
  "username": "my_user",
  "password": "my_password"
}

about 4 years ago · Santiago Gelvez
1 Respuestas
Responde la pregunta

0

You need to remove the extra { } from schema like this:

const paths = {
"/auth/login": {
    "post": {
        "tags": [
            "auth"
        ],
        "summary": "Login",
        "description": "",
        "operationId": "auth-login",
        "consumes": [
            "application/json"
        ],
        "parameters": [
            {
                "name": "Credentials",
                "in": "body",
                "description": "Your credentials",
                "required": true,
                "schema": loginJsonSchema
            }
        ],
        "responses": {
            "200": {
                "description": "successful operation",
                "schema": loginSuccessResponseSchema,
            },
        },
    }
},

See here: https://jsfiddle.net/5gfpy1qr/

about 4 years ago · Santiago Gelvez Denunciar
Responde la pregunta
Encuentra empleos remotos

¡Descubre la nueva forma de encontrar empleo!

Top de empleos
Top categorías de empleo
Empresas
Publicar vacante Precios Comercial
Legal
Términos y condiciones Política de privacidad
© 2026 PeakU Inc. All Rights Reserved.
Andres GPT
Recomiéndame algunas ofertas
Necesito ayuda