How can I configure fabrikt grouping/naming ApiClient classes

[devraj]

Consider this exert from my openapi.yaml file, in this instances defines two endpoints mounted at /api/storefront (for reference these are implemented with Django DRF) and I extensively annotated things (as you can see by the SPEC) where each of them are grouped by the same tag and operationId so provide the best developer experience on the client side.

paths:
  /api/storefront/catalogue/:
    get:
      operationId: getCatalogue
      description: Get the catalogue for the authenticated user's organisation.
      summary: Get Catalogue
      tags:
      - storefront
      security:
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Catalogue'
          description: ''
        '403':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /api/storefront/customer/:
    get:
      operationId: getCustomers
      description: Get the customers for the authenticated user's fleet.
      summary: Get Customers
      parameters:
      - in: query
        name: keywords
        schema:
          type: string
        description: Keywords to search for customers.
      - in: query
        name: limit
        schema:
          type: integer
          default: 100
        description: Number of customers to return per page.
      - in: query
        name: offset
        schema:
          type: integer
          default: 0
        description: Offset for pagination.
      tags:
      - storefront
      security:
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Customer'
          description: Paginated list of customers
        '403':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''

while fabrikt turns the operationIds into nice method names and where there are multiple operations they are grouped together, it still devices to produce an ApiClient class per from what I can tell TitleCased version of the URL endpoints.

It would be nice for us to be able to group these together (which what I thought tags would do for me) so I would have say the ApiStorefrontClient which would contain all the methods tagged with the storefront tag.

Either I am misunderstanding OpenApi Tags or how fabrikt thinks of endpoints. I did try and look through the documentation and examples to see what I can do to wrangle it to produce what I need to. I am using the gradle plugin (for reference).

I was hoping someone here can shed some light onto what either I might be doing wrong or if I can make fabrkt work the way I want to.

PS Thank you for all the work on this project. I am a Swift/iOS guy writing one of my first large scale Android apps and am very appreciative of what fabrikt does.

[ulrikandersen]

Hi there,

this is currently not supported. Fabrikt uses the individual paths to construct the client (and controller) names.

You could define a wrapping StorefrontApiClient facade which delegates to the individual clients, but I get that you would prefer this to happen as part of the generation process.

It would be possible to expand Fabrikt to support this behavior via a configuration flag, but it will require quite a bit of refactoring. Creating a wrapper/facade is your best bet, I would say.

[devraj]

Hello! First of all thank you for responding to my question. I wouldn't go down the path of wanting to change Fabrikt's behaviour, so I will stick to writing some wrappers around it.

Also in the short term I think I can live with what Fabrikt does and understand that all client side code generators are opinionated.