Apache CXF · JSON Structure

Apache Cxf Jaxrs Endpoint Structure

Configuration for a JAX-RS (REST) endpoint in Apache CXF, including address, service class, and features.

Type: object Properties: 5 Required: 2
ApacheJAX-RSJAX-WSJavaOpen SourceRESTSOAPWS-SecurityWeb Services

JaxRsEndpoint is a JSON Structure definition published by Apache CXF, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

address serviceClass features providers properties

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

apache-cxf-jaxrs-endpoint-structure.json Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-cxf/refs/heads/main/json-structure/apache-cxf-jaxrs-endpoint-structure.json",
  "name": "JaxRsEndpoint",
  "description": "Configuration for a JAX-RS (REST) endpoint in Apache CXF, including address, service class, and features.",
  "type": "object",
  "properties": {
    "address": {
      "type": "string",
      "description": "Base URL address for the JAX-RS endpoint.",
      "example": "http://localhost:8080/api"
    },
    "serviceClass": {
      "type": "string",
      "description": "Fully qualified Java class name of the JAX-RS service implementation.",
      "example": "com.example.HelloServiceImpl"
    },
    "features": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of CXF feature class names to apply to this endpoint.",
      "example": [
        "org.apache.cxf.ext.logging.LoggingFeature"
      ]
    },
    "providers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "JAX-RS provider class names (MessageBodyReader, MessageBodyWriter, ExceptionMapper, etc.).",
      "example": [
        "com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider"
      ]
    },
    "properties": {
      "type": "object",
      "description": "Additional CXF endpoint properties."
    }
  },
  "required": [
    "address",
    "serviceClass"
  ]
}