Preguntas etiquetadas con swagger

Tengo una aplicación C # ASP.NET WebAPI con documentación de API que se genera automáticamente usando Swashbuckle . Quiero poder omitir ciertos métodos de la documentación pero parece que no puedo resolver cómo decirle a Swagger que no los incluya en la salida de la interfaz de usuario de Swagger. …

135 c#  asp.net  .net  swagger 

Estoy tratando de transmitir que el esquema de autenticación / seguridad requiere configurar un encabezado de la siguiente manera: Authorization: Bearer <token> Esto es lo que tengo basado en la documentación de swagger : securityDefinitions: APIKey: type: apiKey name: Authorization in: header security: - APIKey: []

112 swagger  swagger-2.0  swagger-editor 

Mi proyecto tiene Spring Security. Problema principal: no se puede acceder a la URL de swagger en http: // localhost: 8080 / api / v2 / api-docs . Dice el encabezado de autorización faltante o no válido. Captura de pantalla de la ventana del navegador Mi pom.xml tiene las siguientes …

92 spring-mvc  swagger  swagger-ui  swagger-2.0  springfox 

Para algunas API REST escritas en PHP, se me pidió que creara la documentación de Swagger , y como no conocía ninguna forma fácil de agregar anotaciones a esas API existentes y crear dicha documentación, usé este editor para generar algunas por ahora. Guardé los archivos JSON y YAML creados …

88 yaml  swagger  swagger-php 

Tengo una API ReSTFul escrita en Spring simple (¡sin Spring Boot, sin cosas elegantes!). Necesito implementar Swagger en esto. Hasta ahora, CADA página de Internet solo me ha vuelto loco con configuraciones confusas y código inflado que no encontré portátil en absoluto. ¿Alguien tiene un proyecto de muestra (o un …

85 spring  spring-mvc  swagger 

Digamos que tengo un parámetro como limit. Este se usa en todas partes y es un dolor tener que cambiarlo en todas partes si necesito actualizarlo: parameters: - name: limit in: query description: Limits the number of returned results required: false type: number format: int32 ¿Puedo usar $ ref para …

84 swagger  swagger-2.0  openapi 

En mi API "simplificada", todas las respuestas se derivan ( heredan ) de una clase de "respuesta" base. La clase de respuesta se compone de un encabezado lleno de metadatos y el cuerpo que contiene los datos básicos que solicita el usuario. La respuesta (en JSON) se presenta de manera …

81 swagger 

Los últimos dos años trabajé en Spring Boot Applications con Springfox. Springfox genera una documentación y una interfaz de usuario de prueba para su API REST. Esto fue asombroso. Pero en realidad el proyecto Springfox está muerto y no es compatible con el nuevo Spring. Tengo tres preguntas ¿Hay alguna …

11 spring-boot  swagger  swagger-ui  springfox 

Estoy desarrollando una API web con .Net core 3.0 y quiero integrarla con SwashBuckle.Swagger. Está funcionando bien, pero cuando agrego autenticación JWT, no funciona como esperaba. Para hacer eso, agregué el siguiente código: services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "My Web API", Version = "v1" }); c.AddSecurityDefinition("Bearer", …

10 swagger  asp.net-core-webapi  swashbuckle  .net-core-3.0 

Estoy integrando la interfaz de usuario swagger en mi proyecto. Necesito pasar el token para hacer una solicitud. const mytoken = "heareismytoken"; const ui = SwaggerUIBundle({ url: "/swagger/v2/swagger.json", dom_id: '#swagger-ui', deepLinking: true, requestInterceptor: function (req) { var key = mytoken; if (key && key.trim() !== "") { req.headers.Authorization = 'Bearer …

8 javascript  swagger  swagger-ui