update openapi plugin

Author: lsmith77

packages/plugins/openapi/src/rest-generator.ts

@@ -44,13 +44,16 @@ type Policies = ReturnType<typeof analyzePolicies>;
  */
 export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
     private warnings: string[] = [];
+    private modelNameMapping: Record<string, string>;
 
     constructor(protected model: Model, protected options: PluginOptions, protected dmmf: DMMF.Document) {
         super(model, options, dmmf);
 
         if (this.options.omitInputDetails !== undefined) {
             throw new PluginError(name, '"omitInputDetails" option is not supported for "rest" flavor');
         }
+
+        this.modelNameMapping = this.getOption('modelNameMapping', {} as Record<string, string>);
     }
 
     generate() {
@@ -126,6 +129,10 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
         return result;
     }
 
+    private mapModelName(modelName: string): string {
+        return this.modelNameMapping[modelName] ?? modelName;
+    }
+
     private generatePathsForModel(model: DMMF.Model, zmodel: DataModel): OAPI.PathItemObject | undefined {
         const result: Record<string, OAPI.PathItemObject> = {};
 
@@ -139,9 +146,11 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
 
         const resourceMeta = getModelResourceMeta(zmodel);
 
+        const modelName = this.mapModelName(model.name);
+
         // GET /resource
         // POST /resource
-        result[`${prefix}/${lowerCaseFirst(model.name)}`] = {
+        result[`${prefix}/${lowerCaseFirst(modelName)}`] = {
             get: this.makeResourceList(zmodel, policies, resourceMeta),
             post: this.makeResourceCreate(zmodel, policies, resourceMeta),
         };
@@ -150,10 +159,10 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
         // PUT /resource/{id}
         // PATCH /resource/{id}
         // DELETE /resource/{id}
-        result[`${prefix}/${lowerCaseFirst(model.name)}/{id}`] = {
+        result[`${prefix}/${lowerCaseFirst(modelName)}/{id}`] = {
             get: this.makeResourceFetch(zmodel, policies, resourceMeta),
-            put: this.makeResourceUpdate(zmodel, policies, `update-${model.name}-put`, resourceMeta),
-            patch: this.makeResourceUpdate(zmodel, policies, `update-${model.name}-patch`, resourceMeta),
+            put: this.makeResourceUpdate(zmodel, policies, `update-${modelName}-put`, resourceMeta),
+            patch: this.makeResourceUpdate(zmodel, policies, `update-${modelName}-patch`, resourceMeta),
             delete: this.makeResourceDelete(zmodel, policies, resourceMeta),
         };
 
@@ -165,14 +174,14 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
             }
 
             // GET /resource/{id}/{relationship}
-            const relatedDataPath = `${prefix}/${lowerCaseFirst(model.name)}/{id}/${field.name}`;
+            const relatedDataPath = `${prefix}/${lowerCaseFirst(modelName)}/{id}/${field.name}`;
             let container = result[relatedDataPath];
             if (!container) {
                 container = result[relatedDataPath] = {};
             }
             container.get = this.makeRelatedFetch(zmodel, field, relationDecl, resourceMeta);
 
-            const relationshipPath = `${prefix}/${lowerCaseFirst(model.name)}/{id}/relationships/${field.name}`;
+            const relationshipPath = `${prefix}/${lowerCaseFirst(modelName)}/{id}/relationships/${field.name}`;
             container = result[relationshipPath];
             if (!container) {
                 container = result[relationshipPath] = {};

packages/server/src/api/rest/index.ts

@@ -245,9 +245,7 @@ class RequestHandler extends APIHandlerBase {
         const segmentCharset = options.urlSegmentCharset ?? 'a-zA-Z0-9-_~ %';
 
         this.modelNameMapping = options.modelNameMapping ?? {};
-        this.reverseModelNameMapping = Object.fromEntries(
-            Object.entries(this.modelNameMapping).map(([k, v]) => [v, k])
-        );
+        this.reverseModelNameMapping = Object.fromEntries(Object.entries(this.modelNameMapping).map(([k, v]) => [v, k]));
         this.urlPatternMap = this.buildUrlPatternMap(segmentCharset);
     }
 
@@ -269,8 +267,8 @@ class RequestHandler extends APIHandlerBase {
         };
     }
 
-    private reverseModelNameMap(type: string): string {
-        return this.reverseModelNameMapping[type] ?? type;
+    private mapModelName(modelName: string): string {
+        return this.modelNameMapping[modelName] ?? modelName;
     }
 
     private matchUrlPattern(path: string, routeType: UrlPatterns): Match {
@@ -281,7 +279,7 @@ class RequestHandler extends APIHandlerBase {
 
         const match = pattern.match(path);
         if (match) {
-            match.type = this.modelNameMapping[match.type] ?? match.type;
+            match.type = this.reverseModelNameMapping[match.type] ?? match.type;
         }
         return match;
     }
@@ -569,7 +567,7 @@ class RequestHandler extends APIHandlerBase {
         }
 
         if (entity?.[relationship]) {
-            const mappedType = this.reverseModelNameMap(type);
+            const mappedType = this.mapModelName(type);
             return {
                 status: 200,
                 body: await this.serializeItems(relationInfo.type, entity[relationship], {
@@ -621,7 +619,7 @@ class RequestHandler extends APIHandlerBase {
         }
 
         const entity: any = await prisma[type].findUnique(args);
-        const mappedType = this.reverseModelNameMap(type);
+        const mappedType = this.mapModelName(type);
 
         if (entity?._count?.[relationship] !== undefined) {
             // build up paginator
@@ -720,7 +718,7 @@ class RequestHandler extends APIHandlerBase {
             ]);
             const total = count as number;
 
-            const mappedType = this.reverseModelNameMap(type);
+            const mappedType = this.mapModelName(type);
             const url = this.makeNormalizedUrl(`/${mappedType}`, query);
             const options: Partial<SerializerOptions> = {
                 include,
@@ -1050,7 +1048,7 @@ class RequestHandler extends APIHandlerBase {
 
         const entity: any = await prisma[type].update(updateArgs);
 
-        const mappedType = this.reverseModelNameMap(type);
+        const mappedType = this.mapModelName(type);
 
         const serialized: any = await this.serializeItems(relationInfo.type, entity[relationship], {
             linkers: {
@@ -1201,7 +1199,7 @@ class RequestHandler extends APIHandlerBase {
 
         for (const model of Object.keys(modelMeta.models)) {
             const ids = getIdFields(modelMeta, model);
-            const mappedModel = this.reverseModelNameMap(model);
+            const mappedModel = this.mapModelName(model);
 
             if (ids.length < 1) {
                 continue;
@@ -1254,7 +1252,7 @@ class RequestHandler extends APIHandlerBase {
                 }
                 const fieldIds = getIdFields(modelMeta, fieldMeta.type);
                 if (fieldIds.length > 0) {
-                    const mappedModel = this.reverseModelNameMap(model);
+                    const mappedModel = this.mapModelName(model);
 
                     const relator = new Relator(
                         async (data) => {