Installations

npm install @openapi-generator-plus/typescript-express-example-server-generator

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.17.0

NPM Version

10.8.2 Pull Requests

Open

3

Total

17

Closed

7

Merged

7

Issues

Open

16

Total

33

Closed

17

Releases

Unable to fetch releases

Contributors

3

Unable to fetch Contributors

View all 3 contributors

Languages

5

Handlebars

TypeScript

Less

JavaScript

Shell

Handlebars (46.97%)

TypeScript (45.76%)

Less (5.02%)

JavaScript (1.48%)

Shell (0.78%)

Developer

karlvr

Download Statistics

Total Downloads

25,802

Last Day

3

Last Week

4

Last Month

143

Last Year

3,843

GitHub Statistics

21 Stars

1,295 Commits

9 Forks

4 Watching

5 Branches

3 Contributors

Maintainers

1

Package Meta Information

Latest Version

1.6.3

Package Id

@openapi-generator-plus/typescript-express-example-server-generator@1.6.3

Unpacked Size

27.13 kB

Size

9.34 kB

File Count

12

NPM Version

10.8.2

Node Version

20.17.0

Publised On

15 Sept 2024

Total Downloads

Cumulative downloads

Total Downloads

25,802

Last day

0%

3

Compared to previous day

Last week

-66.7%

4

Compared to previous week

Last month

-39.4%

143

Compared to previous month

Last year

-50.4%

3,843

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

4

@openapi-generator-plus/types @openapi-generator-plus/generator-common @openapi-generator-plus/handlebars-templates @openapi-generator-plus/typescript-generator-common

Versions

TypeScript Express Example Server API generator for OpenAPI Generator Plus

An OpenAPI Generator Plus template for a TypeScript API server using Express to serve example responses.

If you've added example responses in your OpenAPI spec then this server will output them in response to API requests. If you've specified multiple requests it will randomly choose between them.

Using

See the OpenAPI Generator Plus documentation for how to use generator templates.

Once the generator has been run, the generated package can be run using:

1npm install
2npm start

It will start an API server running on port 3000.

You may also specify a different port:

1npm start -- -p 9000

Config file

The available config file properties are:

Project layout

Property	Type	Description	Default
`relativeSourceOutputPath`	`string`	The path to output generated source code, relative to the output path.	`./` or `./src` if `npm` is specified.

TypeScript

A tsconfig.json file will be output if you specify any of the TypeScript config options.

Property	Type	Description	Default
`typescript`	`TypeScriptConfig`	Configuration for the `tsconfig.json` file.	`undefined`

`TypeScriptConfig`

Property	Type	Description	Default
`target`	`string`	The ECMAScript target version.	`ES5`

Packaging

Property	Type	Description	Default
`npm`	`NpmConfig`	Configuration for generating an npm `package.json`	`undefined`

`NpmConfig`

Property	Type	Description	Default
`name`	`string`	The package name	`typescript-fetch-api`
`version`	`string`	The package version	`0.0.1`
`repository`	`string`	The URL to the package repository	`undefined`

Overrides

Property	Type	Description	Default
`customTemplates`	`string`	The path to a directory containing custom Handlebars templates, relative to the config file. See Customising below.	`undefined`

Customising

This generator supports a customTemplates config file property to specify a directory containing Handlebars templates that will be used to override built-in templates.

Any custom template will have the original template available as a partial named by prefixing the template name with original, and then upper-casing the first letter, e.g. originalModelEnum.

Some of the templates in the generator are designed to support overriding for custom requirements. Please inspect the templates in the templates directory.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

SAST

Determines if the project uses static code analysis.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

3.4

/10

Last Scanned on 2024-12-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More