[Feature Request] Customizing the RESTful API endpoints

[ymc9]

For example, one may want to use plural endpoint names instead of singular ones.

[ymc9]

We also need to think about how to synchronize the API runtime behavior and the specs generated by the openapi plugin.

[Nauxie]

For example, one may want to use plural endpoint names instead of singular ones.

Has a solution for this been built into zenstack? Or do you recommend using @@map?

@ymc9

[ymc9]

Hi @Nauxie , nothing has been designed yet but I'm interested in knowing what customization you're looking for.

[lsmith77]

I would prefer to be able to use pluralization, so I am looking if there is some hook I can use. Semi-related I am also running into issues using Nest.js API versioning.

const api_prefix = 'api';

  app
    .enableVersioning({
      type: VersioningType.URI,
      defaultVersion: '1',
    })
    .setGlobalPrefix(api_prefix);

This adds /api/v1 to every URL but then ZenStack thinks the model is api:

curl localhost:3000/api/v1/post leads to:

{"errors":[{"status":404,"code":"unsupported-model","title":"Unsupported model type","detail":"Model api doesn't exist"}]}%

If there would be some hook here I could add some custom logic that can determine the model name.

[lsmith77]

I wonder if all that is needed is to turn this line into an optional callback rather than a simple array lookup?

const typeInfo = this.typeMap[type];

https://github.com/zenstackhq/zenstack/blob/main/packages/server/src/api/rest/index.ts#L439

[lsmith77]

Or probably better to turn these lines to an optional callback:
let match = this.urlPatterns.single.match(path);

https://github.com/zenstackhq/zenstack/blob/main/packages/server/src/api/rest/index.ts#L277C21-L277C69

[lsmith77]

Not sure if this would then also need some additional work for the OpenAPI generation.

[lsmith77]

#2187