Package sk.iway.iwcm.system.spring.openapi

Class OpenApiRestController

java.lang.Object

sk.iway.iwcm.system.spring.openapi.OpenApiRestController

@RestController
@PreAuthorize("@WebjetSecurityService.hasPermission(\'users.edit_admins\')")
public class OpenApiRestController
extends Object

REST controller for generating OpenAPI documentation. Scans all @RestController beans with Spring MVC annotations and generates OpenAPI spec. Access URLs: - JSON: /admin/rest/openapi/api-docs - Swagger UI: /admin/swagger-ui/index.html

Constructor Summary

Constructors

Constructor	Description
OpenApiRestController()

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clears the cached OpenAPI specification
String	getOpenApiJson()	Returns OpenAPI specification in JSON format

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenApiRestController

public OpenApiRestController()

Method Details

getOpenApiJson

@GetMapping(value="/admin/rest/openapi/api-docs",
            produces="application/json")
public String getOpenApiJson()

Returns OpenAPI specification in JSON format

Returns:

OpenAPI JSON

clearCache

public void clearCache()

Clears the cached OpenAPI specification