npmpackage.info

Gathering detailed insights and metrics for @nestjsx/api-version

Other packages similar to @nestjsx/api-version

@nestjsx/crud

5.0.0-alpha.3

NestJs CRUD for RESTful APIs

@nestjsx/crud-request

5.0.0-alpha.3

NestJs CRUD for RESTful APIs - request query builder

@nestjsx/util

5.0.0-alpha.3

NestJs CRUD for RESTful APIs - util

@nestjsx/crud-typeorm

5.0.0-alpha.3

NestJs CRUD for RESTful APIs - TypeORM

Gathering detailed insights and metrics for @nestjsx/api-version

@nestjsx/api-version

Nest api version (global prefix) guard

0.1.1

MIT

TypeScript

55,398 1.7

Installations

npm install @nestjsx/api-version

Pull Requests

Open

1

Total

3

Closed

2

Issues

Open

2

Total

3

Closed

1

Releases

Unable to fetch releases

Developer

zMotivat0r

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

9.11.1

NPM Version

5.6.0 Statistics

34 Stars

2 Commits

1 Forks

1 Branches

1 Contributors

Updated on 30 Dec 2023

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

55,398

Last day

Compared to previous day

Last week

90%

Compared to previous week

Last month

59.2%

Compared to previous month

Last year

-39.1%

1,068

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

@nestjs/common

Versions

Nest api version (global prefix) guard

@nestjsx/api-verion has been designed to quickly help you with the access logic if you're using global prefix in your application and want to restrict an access to different API endpoints with different API versions. For now it works with Express and Fastify adapters.

Install

1npm i @nestjsx/api-version --save

Usage

1. Enable `global prefix` in your bootstrap file

1import { NestFactory } from '@nestjs/core';
2import { ApplicationModule } from './app.module';
3
4async function bootstrap() {
5  const app = await NestFactory.create(ApplicationModule);
6  app.setGlobalPrefix('v1'); // <-- here
7  await app.listen(3000);
8}
9bootstrap();

2. Connect `ApiVersionGuard` in app module

1import { ApiVersionGuard } from '@nestjsx/api-version';
2import { Module } from '@nestjs/common';
3import { APP_GUARD } from '@nestjs/core';
4
5@Module({
6  providers: [
7    {
8      provide: APP_GUARD,
9      useClass: ApiVersionGuard,
10    },
11  ],
12})
13export class ApplicationModule {}

3. Use `ApiVersion` decorator in your controller

1import { ApiVersion } from '@nestjsx/api-version';
2import { Controller, Get } from '@nestjs/common';
3
4@Controller('cats')
5export class CatsController {
6  @Get()
7  @ApiVersion()
8  findAllV1() {
9    return 'This action will work in all versions';
10  }
11
12  @Get()
13  @ApiVersion('v1')
14  findAllV1() {
15    return 'This action will work in v1 version';
16  }
17
18  @Get()
19  @ApiVersion('v2')
20  findAllNext() {
21    return 'This action will work in v2 version only';
22  }
23}

Tests

1npm run test:e2e

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

0

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

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

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

83 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-4jpv-8r57-pv7j
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-42xw-2xvc-qx8m
Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-h452-7996-h45h
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-wm7h-9275-46v2
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2024-11-18

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

Other packages similar to @nestjsx/api-version

@nestjsx/api-version

Installations

Pull Requests

1

3

2

Issues

2

3

1

Releases

Unable to fetch releases

Developer

zMotivat0r

Developer Guide

CommonJS

Yes

9.11.1

5.6.0

Statistics

Languages

Total Downloads

55,398

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Nest api version (global prefix) guard

Install

Usage

1. Enable global prefix in your bootstrap file

2. Connect ApiVersionGuard in app module

3. Use ApiVersion decorator in your controller

Tests

License

10

10

0

0

0

0

0

0

0

0

1.7

/10

Other packages similar to @nestjsx/api-version

1. Enable `global prefix` in your bootstrap file

2. Connect `ApiVersionGuard` in app module

3. Use `ApiVersion` decorator in your controller