Ya estoy inscrito ¿Todavía no tienes acceso? Nuestros Planes
Ya estoy inscrito ¿Todavía no tienes acceso? Nuestros Planes
1
respuesta

[Duda] Consulta

Hola tengo una duda sobre la implementacion de OpenAi o Swagger. En mi caso lo he realizado asi en el curso anterior de 'security', queria saber si esta mal?


import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeIn;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
import io.swagger.v3.oas.annotations.info.Contact;
import io.swagger.v3.oas.annotations.info.Info;
import io.swagger.v3.oas.annotations.info.License;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import io.swagger.v3.oas.annotations.security.SecurityScheme;
import io.swagger.v3.oas.annotations.servers.Server;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpHeaders;

@OpenAPIDefinition(
        info = @Info(
                title = "Clinic-API-Security",
                description = "Clinic where patient and doctor data can be uploaded.",
                termsOfService = "www.toby959.com/Terms_and_services",
                version = "1.0.0",
                contact = @Contact(
                        name = "Christian Garay",
                        url = "www.tobias959.com/contact",
                        email = "www.christiangarayw8@gmail.com"
                ),
                license = @License(
                        name = "Standard Software Use License for toby959",
                        url = "www.tobias959.com/license"
                )
        ),
        servers = {
                @Server(
                        description = "DEV SERVER",
                        url = "http://localhost:8000"
                ),
                @Server(
                        description = "PROD SERVER",
                        url = "http://toby959:8080"
                )
        },
        security = @SecurityRequirement(
                name = "Security Token"
        )
)
@SecurityScheme(
        name = "Security Token",
        description = "Access Token For My API",
        type = SecuritySchemeType.HTTP,
        paramName = HttpHeaders.AUTHORIZATION,
        in = SecuritySchemeIn.HEADER,
        scheme = "bearer",
        bearerFormat = "JWT"
)
@Configuration
public class SwaggerConfig {}
1 respuesta

¡Hola Christian!

Por lo que veo, estás implementando OpenAPI (anteriormente conocido como Swagger) en tu proyecto Spring Boot para documentar tu API. El código que has compartido parece estar bien estructurado y siguiendo las anotaciones necesarias para definir la documentación de la API.

Si estás utilizando SpringDoc, puedes seguir utilizando las anotaciones proporcionadas por OpenAPI para documentar tu API de manera automática. Asegúrate de que has añadido las dependencias necesarias en tu archivo pom.xml o build.gradle para que SpringDoc pueda generar la documentación de la API de forma automática.

Si tienes algún problema específico al implementar OpenAPI o Swagger, no dudes en proporcionar más detalles para que pueda ayudarte de manera más específica.

Espero haber ayudado y buenos estudios!

Si este post te ayudó, por favor, marca como solucionado ✓. Continúa con tus estudios!