mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-06-06 18:30:57 +00:00
9884c65b10
# Description This pull request includes several changes aimed at improving the code structure and removing redundant code. The most significant changes involve reordering methods, removing unnecessary annotations, and refactoring constructors to use dependency injection. Autowired now comes via constructor (which also doesn't need autowired annotation as its done by default for configuration) ## Checklist - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have performed a self-review of my own code - [ ] I have attached images of the change if it is UI based - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] If my code has heavily changed functionality I have updated relevant docs on [Stirling-PDFs doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) - [ ] My changes generate no new warnings - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only)
57 lines
2.3 KiB
Java
57 lines
2.3 KiB
Java
package stirling.software.SPDF.config;
|
|
|
|
import org.springframework.context.annotation.Bean;
|
|
import org.springframework.context.annotation.Configuration;
|
|
|
|
import io.swagger.v3.oas.models.Components;
|
|
import io.swagger.v3.oas.models.OpenAPI;
|
|
import io.swagger.v3.oas.models.info.Info;
|
|
import io.swagger.v3.oas.models.security.SecurityRequirement;
|
|
import io.swagger.v3.oas.models.security.SecurityScheme;
|
|
|
|
import stirling.software.SPDF.model.ApplicationProperties;
|
|
|
|
@Configuration
|
|
public class OpenApiConfig {
|
|
|
|
private final ApplicationProperties applicationProperties;
|
|
|
|
public OpenApiConfig(ApplicationProperties applicationProperties) {
|
|
this.applicationProperties = applicationProperties;
|
|
}
|
|
|
|
@Bean
|
|
public OpenAPI customOpenAPI() {
|
|
String version = getClass().getPackage().getImplementationVersion();
|
|
if (version == null) {
|
|
// default version if all else fails
|
|
version = "1.0.0";
|
|
}
|
|
SecurityScheme apiKeyScheme =
|
|
new SecurityScheme()
|
|
.type(SecurityScheme.Type.APIKEY)
|
|
.in(SecurityScheme.In.HEADER)
|
|
.name("X-API-KEY");
|
|
if (!applicationProperties.getSecurity().getEnableLogin()) {
|
|
return new OpenAPI()
|
|
.components(new Components())
|
|
.info(
|
|
new Info()
|
|
.title("Stirling PDF API")
|
|
.version(version)
|
|
.description(
|
|
"API documentation for all Server-Side processing.\nPlease note some functionality might be UI only and missing from here."));
|
|
} else {
|
|
return new OpenAPI()
|
|
.components(new Components().addSecuritySchemes("apiKey", apiKeyScheme))
|
|
.info(
|
|
new Info()
|
|
.title("Stirling PDF API")
|
|
.version(version)
|
|
.description(
|
|
"API documentation for all Server-Side processing.\nPlease note some functionality might be UI only and missing from here."))
|
|
.addSecurityItem(new SecurityRequirement().addList("apiKey"));
|
|
}
|
|
}
|
|
}
|