forked from zenstackhq/zenstack
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: restful style openapi spec generation (zenstackhq#410)
- Loading branch information
Showing
14 changed files
with
6,089 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
import { DMMF } from '@prisma/generator-helper'; | ||
import { PluginError, PluginOptions, getDataModels, hasAttribute } from '@zenstackhq/sdk'; | ||
import { Model } from '@zenstackhq/sdk/ast'; | ||
import type { OpenAPIV3_1 as OAPI } from 'openapi-types'; | ||
import { SecuritySchemesSchema } from './schema'; | ||
import { fromZodError } from 'zod-validation-error'; | ||
|
||
export abstract class OpenAPIGeneratorBase { | ||
constructor(protected model: Model, protected options: PluginOptions, protected dmmf: DMMF.Document) {} | ||
|
||
abstract generate(): string[]; | ||
|
||
protected get includedModels() { | ||
return getDataModels(this.model).filter((d) => !hasAttribute(d, '@@openapi.ignore')); | ||
} | ||
|
||
protected wrapArray( | ||
schema: OAPI.ReferenceObject | OAPI.SchemaObject, | ||
isArray: boolean | ||
): OAPI.ReferenceObject | OAPI.SchemaObject { | ||
if (isArray) { | ||
return { type: 'array', items: schema }; | ||
} else { | ||
return schema; | ||
} | ||
} | ||
|
||
protected array(itemType: OAPI.SchemaObject | OAPI.ReferenceObject) { | ||
return { type: 'array', items: itemType } as const; | ||
} | ||
|
||
protected oneOf(...schemas: (OAPI.SchemaObject | OAPI.ReferenceObject)[]) { | ||
return { oneOf: schemas }; | ||
} | ||
|
||
protected allOf(...schemas: (OAPI.SchemaObject | OAPI.ReferenceObject)[]) { | ||
return { allOf: schemas }; | ||
} | ||
|
||
protected getOption<T = string>(name: string): T | undefined; | ||
protected getOption<T = string, D extends T = T>(name: string, defaultValue: D): T; | ||
protected getOption<T = string>(name: string, defaultValue?: T): T | undefined { | ||
const value = this.options[name]; | ||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment | ||
// @ts-expect-error | ||
return value === undefined ? defaultValue : value; | ||
} | ||
|
||
protected generateSecuritySchemes() { | ||
const securitySchemes = this.getOption<Record<string, string>[]>('securitySchemes'); | ||
if (securitySchemes) { | ||
const parsed = SecuritySchemesSchema.safeParse(securitySchemes); | ||
if (!parsed.success) { | ||
throw new PluginError(`"securitySchemes" option is invalid: ${fromZodError(parsed.error)}`); | ||
} | ||
return parsed.data; | ||
} | ||
return undefined; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,16 @@ | ||
import { DMMF } from '@prisma/generator-helper'; | ||
import { PluginOptions } from '@zenstackhq/sdk'; | ||
import { Model } from '@zenstackhq/sdk/ast'; | ||
import { OpenAPIGenerator } from './generator'; | ||
import { RESTfulOpenAPIGenerator } from './rest-generator'; | ||
import { RPCOpenAPIGenerator } from './rpc-generator'; | ||
|
||
export const name = 'OpenAPI'; | ||
|
||
export default async function run(model: Model, options: PluginOptions, dmmf: DMMF.Document) { | ||
return new OpenAPIGenerator(model, options, dmmf).generate(); | ||
const flavor = options.flavor ? (options.flavor as string) : 'restful'; | ||
if (flavor === 'restful') { | ||
return new RESTfulOpenAPIGenerator(model, options, dmmf).generate(); | ||
} else { | ||
return new RPCOpenAPIGenerator(model, options, dmmf).generate(); | ||
} | ||
} |
Oops, something went wrong.