¿Cómo puedo documentar objetos que no tengo la propiedad? -- swagger campo con swagger-ui campo con openapi campo con springdoc campo con springdoc-openui camp Relacionados El problema

How can I document objects that I don't have ownership over?


3
vote

problema

Español

Estoy devolviendo un val explicitLeftOuterJoin = for { (c, s) <- Coffees leftJoin Suppliers on (_.supID === _.id) } yield (c, s.?) 0 en My Method Puntos finales. En mi UI Openapi, ¿cómo puedo generar una descripción de los campos que provienen de val explicitLeftOuterJoin = for { (c, s) <- Coffees leftJoin Suppliers on (_.supID === _.id) } yield (c, s.?) 1 ? Normalmente, lo que hago es ir al objeto que quiero documentar y anotar sus campos con val explicitLeftOuterJoin = for { (c, s) <- Coffees leftJoin Suppliers on (_.supID === _.id) } yield (c, s.?) 2 . Pero no tengo acceso a la clase val explicitLeftOuterJoin = for { (c, s) <- Coffees leftJoin Suppliers on (_.supID === _.id) } yield (c, s.?) 3 . ¿Cómo puedo documentar sus campos?

Probablemente estoy perdiendo algo simple aquí, pero cualquier ayuda sería apreciada.

PS: Estoy usando OpenAPI V3 y SpringDOC

Original en ingles

I'm returning a Page<SomeObject> In my method endpoints. In my OpenAPI UI, how can I generate a description of the fields that come from org.springframework.data.domain.Page type. Normally what I do is go to the Object that I want to document and annotate its fields with @Schema(description = "some description"). But I don't have access to the Page class. How can I document its fields?

I'm probably missing something simple here, but any help would be appreciated.

PS: I am using OpenAPI v3 and springdoc

              

Lista de respuestas

0
 
vote
vote
La mejor respuesta
 

Puedes usar Openapicustomiser.

Digamos por ejemplo, tiene este controlador:

@RestController Clase pública HellOcontroller {

  Option[YourClass]6  

}

Supongamos que desea agregar la descripción el elemento Pagable:

  Option[YourClass]7  

La misma lógica se aplica para cualquier otro atributo que ha anulado para personalizar.

 

You can use OpenApiCustomiser.

Let's say for example you have this controller:

@RestController public class HelloController {

@GetMapping("/hello") Page<PersonDTO> getPage() {     return null; } 

}

Let's suppose you want add the description the Pageable element:

@Bean public OpenApiCustomiser pageableOpenApiCustomiser() {     return openApi -> {         Schema pageableSchema = openApi.getComponents().getSchemas().get("Pageable");         pageableSchema.setDescription("my description");     }; } 

The same logic applies for any other attribute you nned to customize.

 
 

Relacionados problema

0  API API API DE SPRING-DOC no funciona con Spring Cloud Config Server @Enableconfigserver  ( Spring doc open api not working with spring cloud config server enableconfigser ) 
IM UTILIZANDO AlreadyStartedActivity0 CON AlreadyStartedActivity111 . Estoy tratando de implementar el AlreadyStartedActivity2 en un proyecto existente. ...

1  Extensión SpringDoc para AWS API GATANTARIO  ( Springdoc extension for aws api gatewary ) 
Quiero migrar desde Springfox 2 a SpringDOC. Actualmente, hay varios complementos (springfox.documentation.spi.service.operationbuilderplugin) implementados u...

0  ¿Mantén la misma URL, pero los cambios de contrato en el arranque de la primavera se abren API 3?  ( Keep same url but contract changes in spring boot rest open api 3 ) 
Estoy usando val df3 = df2.groupBy("name").agg(<someaggregations>) df2.unpersist val df4 = df3.partition(col("id").cache 0 Implementación. En este ejemplo, ...

1  ¿Cómo generar solicitud de tipo de tipo de mapa <string, objeto> usando SpringDOC para Swagger Open API 3.0?  ( How to generate requestbody of type mapstring object using springdoc for swag ) 
query.json2 Para el código anterior, solo el parámetro query.json3 se está generando y su solicitud de solicitud completamente faltante. Añadí Tipo = "O...

2  ¿Cómo crear múltiples esquemas en @Requestbody Of Swagger Openapi Especification 3.0 usando SpringDOC?  ( How to create multiple schema in requestbody of swagger openapi specification 3 ) 
Tengo la siguiente API para la cual necesito tener dos parámetros de tipo de contenido application/x-www-form-urlencoded y, por lo tanto, estoy usando @Req...

2  Spring DOCS - Abra la API 3 - ¿Cómo configurar los valores predeterminados en el cuerpo?  ( Spring docs open api 3 how to set default values to body ) 
Estoy usando boot boot + spring data Mongo + Spring Resto + Spring Hateoas para implementar los puntos finales de descanso. Dado que estamos pasando más d...

3  ¿Cómo puedo documentar objetos que no tengo la propiedad?  ( How can i document objects that i dont have ownership over ) 
Estoy devolviendo un val explicitLeftOuterJoin = for { (c, s) <- Coffees leftJoin Suppliers on (_.supID === _.id) } yield (c, s.?) 0 en My Method Puntos f...

0  Springdoc Openapi Swagger Mergernenotations Error  ( Springdoc openapi swagger mergeannotations error ) 
Estoy tratando de configurar OpenAPI con Swagger a mi aplicación de inicio sin resorte existente. primavera v.5.1.8.Release Springdoc v.1.4.6 Spring-Boot v....

0  Springdoc App-Doc.Yaml no muestra el Doc Swagger  ( Springdoc app doc yaml dont show the swagger doc ) 
Tengo una API con Swagger. Ejemplo de punto final: @ApiOperation(value = "Returns a list of Pix transactions.",httpMethod = "POST",response = DResponse.cla...

0  ¿Cómo integrar Swagger con Springdoc Yaml?  ( How to integrate swagger with springdoc yaml ) 
Estoy usando Swagger para documentar mi proyecto. Y quiero generar el Doc de Yaml de SpringDOC. Pero cuando genere esta documentación de Yaml, el Yaml no teng...




© 2022 respuesta.top Reservados todos los derechos. Centro de preguntas y respuestas reservados todos los derechos