Apache OFBiz REST API — Services

naftiko: 1.0.0-alpha2
info:
  label: Apache OFBiz REST API — Services
  description: 'Apache OFBiz REST API — Services. 3 operations. Lead operation: Apache OFBiz List All Exported Services. Self-contained
    Naftiko capability covering one Apache Ofbiz business surface.'
  tags:
  - Apache Ofbiz
  - Services
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    APACHE_OFBIZ_API_KEY: APACHE_OFBIZ_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-services
    baseUri: https://localhost:8443/rest
    description: Apache OFBiz REST API — Services business capability. Self-contained, no shared references.
    resources:
    - name: services
      path: /services
      operations:
      - name: getservices
        method: GET
        description: Apache OFBiz List All Exported Services
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-serviceName
      path: /services/{serviceName}
      operations:
      - name: invokeserviceget
        method: GET
        description: Apache OFBiz Invoke Service via GET
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: serviceName
          in: path
          type: string
          description: The name of the OFBiz service to invoke.
          required: true
        - name: inParams
          in: query
          type: string
          description: URL-encoded JSON string of service input parameters.
      - name: invokeservicepost
        method: POST
        description: Apache OFBiz Invoke Service via POST
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: serviceName
          in: path
          type: string
          description: The name of the OFBiz service to invoke.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.APACHE_OFBIZ_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-services-rest
    port: 8080
    description: REST adapter for Apache OFBiz REST API — Services. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/services
      name: services
      description: REST surface for services.
      operations:
      - method: GET
        name: getservices
        description: Apache OFBiz List All Exported Services
        call: rest-services.getservices
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/{servicename}
      name: services-servicename
      description: REST surface for services-serviceName.
      operations:
      - method: GET
        name: invokeserviceget
        description: Apache OFBiz Invoke Service via GET
        call: rest-services.invokeserviceget
        with:
          serviceName: rest.serviceName
          inParams: rest.inParams
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: invokeservicepost
        description: Apache OFBiz Invoke Service via POST
        call: rest-services.invokeservicepost
        with:
          serviceName: rest.serviceName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-services-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache OFBiz REST API — Services. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: apache-ofbiz-list-all-exported
      description: Apache OFBiz List All Exported Services
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-services.getservices
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-ofbiz-invoke-service-get
      description: Apache OFBiz Invoke Service via GET
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-services.invokeserviceget
      with:
        serviceName: tools.serviceName
        inParams: tools.inParams
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-ofbiz-invoke-service-post
      description: Apache OFBiz Invoke Service via POST
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-services.invokeservicepost
      with:
        serviceName: tools.serviceName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.