Apache APISIX · Capability

Apache APISIX Admin API — Consumers

Apache APISIX Admin API — Consumers. 9 operations. Lead operation: Apache APISIX List All Consumers. Self-contained Naftiko capability covering one Apache Apisix business surface.

Run with Naftiko Apache ApisixConsumers

What You Can Do

GET

Listconsumers — Apache APISIX List All Consumers

/v1/consumers

GET

Getconsumer — Apache APISIX Get a Consumer

/v1/consumers/{username}

PUT

Createorupdateconsumer — Apache APISIX Create or Update a Consumer

/v1/consumers/{username}

DELETE

Deleteconsumer — Apache APISIX Delete a Consumer

/v1/consumers/{username}

GET

Listconsumercredentials — Apache APISIX List Consumer Credentials

/v1/consumers/{username}/credentials

GET

Getconsumercredential — Apache APISIX Get a Consumer Credential

/v1/consumers/{username}/credentials/{credential-id}

PUT

Createorupdateconsumercredential — Apache APISIX Create or Update a Consumer Credential

/v1/consumers/{username}/credentials/{credential-id}

PATCH

Patchconsumercredential — Apache APISIX Patch a Consumer Credential

/v1/consumers/{username}/credentials/{credential-id}

DELETE

Deleteconsumercredential — Apache APISIX Delete a Consumer Credential

naftiko: 1.0.0-alpha2
info:
  label: Apache APISIX Admin API — Consumers
  description: 'Apache APISIX Admin API — Consumers. 9 operations. Lead operation: Apache APISIX List All Consumers. Self-contained
    Naftiko capability covering one Apache Apisix business surface.'
  tags:
  - Apache Apisix
  - Consumers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    APACHE_APISIX_API_KEY: APACHE_APISIX_API_KEY
capability:
  consumes:
  - type: http
    namespace: admin-consumers
    baseUri: http://127.0.0.1:9180/apisix/admin
    description: Apache APISIX Admin API — Consumers business capability. Self-contained, no shared references.
    resources:
    - name: consumers
      path: /consumers
      operations:
      - name: listconsumers
        method: GET
        description: Apache APISIX List All Consumers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: consumers-username
      path: /consumers/{username}
      operations:
      - name: getconsumer
        method: GET
        description: Apache APISIX Get a Consumer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createorupdateconsumer
        method: PUT
        description: Apache APISIX Create or Update a Consumer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteconsumer
        method: DELETE
        description: Apache APISIX Delete a Consumer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: consumers-username-credentials
      path: /consumers/{username}/credentials
      operations:
      - name: listconsumercredentials
        method: GET
        description: Apache APISIX List Consumer Credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: consumers-username-credentials-credential_id
      path: /consumers/{username}/credentials/{credential_id}
      operations:
      - name: getconsumercredential
        method: GET
        description: Apache APISIX Get a Consumer Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createorupdateconsumercredential
        method: PUT
        description: Apache APISIX Create or Update a Consumer Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: patchconsumercredential
        method: PATCH
        description: Apache APISIX Patch a Consumer Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteconsumercredential
        method: DELETE
        description: Apache APISIX Delete a Consumer Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-API-KEY
      value: '{{env.APACHE_APISIX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: admin-consumers-rest
    port: 8080
    description: REST adapter for Apache APISIX Admin API — Consumers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/consumers
      name: consumers
      description: REST surface for consumers.
      operations:
      - method: GET
        name: listconsumers
        description: Apache APISIX List All Consumers
        call: admin-consumers.listconsumers
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/consumers/{username}
      name: consumers-username
      description: REST surface for consumers-username.
      operations:
      - method: GET
        name: getconsumer
        description: Apache APISIX Get a Consumer
        call: admin-consumers.getconsumer
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: createorupdateconsumer
        description: Apache APISIX Create or Update a Consumer
        call: admin-consumers.createorupdateconsumer
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteconsumer
        description: Apache APISIX Delete a Consumer
        call: admin-consumers.deleteconsumer
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/consumers/{username}/credentials
      name: consumers-username-credentials
      description: REST surface for consumers-username-credentials.
      operations:
      - method: GET
        name: listconsumercredentials
        description: Apache APISIX List Consumer Credentials
        call: admin-consumers.listconsumercredentials
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/consumers/{username}/credentials/{credential-id}
      name: consumers-username-credentials-credential-id
      description: REST surface for consumers-username-credentials-credential_id.
      operations:
      - method: GET
        name: getconsumercredential
        description: Apache APISIX Get a Consumer Credential
        call: admin-consumers.getconsumercredential
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: createorupdateconsumercredential
        description: Apache APISIX Create or Update a Consumer Credential
        call: admin-consumers.createorupdateconsumercredential
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchconsumercredential
        description: Apache APISIX Patch a Consumer Credential
        call: admin-consumers.patchconsumercredential
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteconsumercredential
        description: Apache APISIX Delete a Consumer Credential
        call: admin-consumers.deleteconsumercredential
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: admin-consumers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache APISIX Admin API — Consumers. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: apache-apisix-list-all-consumers
      description: Apache APISIX List All Consumers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-consumers.listconsumers
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-apisix-get-consumer
      description: Apache APISIX Get a Consumer
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-consumers.getconsumer
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-apisix-create-update-consumer
      description: Apache APISIX Create or Update a Consumer
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: admin-consumers.createorupdateconsumer
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-apisix-delete-consumer
      description: Apache APISIX Delete a Consumer
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: admin-consumers.deleteconsumer
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-apisix-list-consumer-credentials
      description: Apache APISIX List Consumer Credentials
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-consumers.listconsumercredentials
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-apisix-get-consumer-credential
      description: Apache APISIX Get a Consumer Credential
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-consumers.getconsumercredential
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-apisix-create-update-consumer-2
      description: Apache APISIX Create or Update a Consumer Credential
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: admin-consumers.createorupdateconsumercredential
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-apisix-patch-consumer-credential
      description: Apache APISIX Patch a Consumer Credential
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: admin-consumers.patchconsumercredential
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-apisix-delete-consumer-credential
      description: Apache APISIX Delete a Consumer Credential
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: admin-consumers.deleteconsumercredential
      outputParameters:
      - type: object
        mapping: $.