Historial de página

...

@OpenAPIDefinition (
    info = @Info(title = "TITULO DE LA APLICACIÓN", version = "${server.image:0.0.0}", description = "DESCRIPCIÓN DEL API."),
    servers = { @Server(url="${springdoc.server.url}") }
)
@SecurityScheme(
    name = "OIDC",
    type = SecuritySchemeType.OPENIDCONNECT,
    openIdConnectUrl = "${springdoc.security.issuer-uri}/.well-known/openid-configuration"
)

...

            De este código, modificar únicamente los atributos:

• title => Título que se mostrará en la documentación. Si tenemos varias clases según los recursos (como debería ser), mencionar en este title el recurso con el que se trabaja en la clase.
               P.Ej.: "Consulta de Expediente Académico", "Consulta de Datos de Afiliación", "Solicitudes de Matrícula".
• description => Descripción larga genérica de los endpoints expuestos en la clase.

      3.2 Anotaciones de método

...

 @Operation(summary = "TITULO DEL ENDPOINT", 
            description = "DESCRIPCION DEL ENDPOINT.",
            tags = {"Public"}, //TAG PARA AGRUPAR EN LA DOCUMENTACIÓN
            responses = { 
                 @ApiResponse(responseCode = "200500", //CODIGO DE RESPUESTAdescription=""), 
                 @ApiResponse(responseCode = "200", 
                             description="DESCRIPCION DE LA RESPUESTA SEGÚN EL CÓDIGO DEVUELTO",
                            content= @Content(schema=@Schema(implementation=GithubUserClaseDTODevuelto.class))) //CONTENIDO DE LA RESPUESTA SEGÚN EL CÓDIGO DEVUELTO
                .... Incluir todos los ApiResponse necesarios.
            })

De este código los atributos a configurar serían:

• summary => Título, resumen descriptivo del endpoint.
• description => Descripción larga del endpoint.
• tags => Listado de tags para agrupar endpoints en la documentación. Se recomienda usar solo, de momento, "Public" o "Private" según el ámbito de nuestro endpoint.
• responses => Listado de códigos de respuesta devueltos por el endpoint. 
                       Rellenar, según el caso:
  • • • responseCode => código de respuesta http
      • description => descripción de la casuística cuando se devuelve el código de respuesta
      • content => clase devuelta cuando sucede la respuesta, por ejemplo, un DTO devuelto. (No incluir en caso de error o desconocimiento, es opcional).

Se recomienda que los endpoints controlen y devuelvan un conjunto de respuestas completos, según la situación controlada. Ver => Manejo de Errores en FundeWebJS.

Artículos Relacionados

...