Package io.jmix.rest.impl.controller

Class DocumentationController

java.lang.Object
io.jmix.rest.impl.controller.DocumentationController
@RestController("rest_DocumentationController") @RequestMapping("${jmix.rest.base-path}${jmix.rest.docs-path}") public class DocumentationController extends Object

  • Field Details

    • resources

      @Autowired protected Resources resources

    • openAPIGenerator

      @Autowired protected OpenAPIGenerator openAPIGenerator

    • restProperties

      @Autowired protected RestProperties restProperties

    • servletContext

      @Autowired(required=false) protected jakarta.servlet.ServletContext servletContext

    • yamlMapper

      protected com.fasterxml.jackson.databind.ObjectMapper yamlMapper

    • jsonMapper

      protected com.fasterxml.jackson.databind.ObjectMapper jsonMapper

  • Constructor Details

    • DocumentationController

      public DocumentationController()

  • Method Details

    • getOpenApiYaml

      @RequestMapping(value="/openapi.yaml", method=GET, produces="application/yaml") public String getOpenApiYaml()

    • getOpenApiJson

      @RequestMapping(value="/openapi.json", method=GET, produces="application/json") public String getOpenApiJson()

    • getOpenApiRootNode

      protected com.fasterxml.jackson.databind.JsonNode getOpenApiRootNode() throws com.fasterxml.jackson.core.JsonProcessingException
      Throws:
      com.fasterxml.jackson.core.JsonProcessingException

    • getServerUrl

      protected String getServerUrl()

    • getProjectOpenApiYaml

      @RequestMapping(value="/openapiDetailed.yaml", method=GET, produces="application/yaml") public String getProjectOpenApiYaml()

    • getProjectOpenApiJson

      @RequestMapping(value="/openapiDetailed.json", method=GET, produces="application/json") public String getProjectOpenApiJson()