Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/julianpoemp/nestjs-redox
This NestJS module enables to auto-generate beautiful API docs using Swagger and Redoc. It supports NestJS 10, ExpressJS and Fastify.
https://github.com/julianpoemp/nestjs-redox
expressjs fastify nestjs open-api swagger
Last synced: 6 days ago
JSON representation
This NestJS module enables to auto-generate beautiful API docs using Swagger and Redoc. It supports NestJS 10, ExpressJS and Fastify.
- Host: GitHub
- URL: https://github.com/julianpoemp/nestjs-redox
- Owner: julianpoemp
- License: mit
- Created: 2024-03-01T18:14:51.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-11T06:37:15.000Z (2 months ago)
- Last Synced: 2024-10-05T16:08:58.793Z (about 1 month ago)
- Topics: expressjs, fastify, nestjs, open-api, swagger
- Language: TypeScript
- Homepage:
- Size: 1.59 MB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
NestJS-Redox 
This NestJS module enables to auto-generate beautiful API docs using Swagger and Redoc. It supports NestJS 10, ExpressJS and Fastify.
## Features
- NestJS 10 support
- ExpressJS and Fastify support
- Multi-user auth basic support
- Option "standalone" for self hosted redoc bundles without requesting a CDN.
- Option to disable Google fonts
Using the "standalone" Option in combination with "disableGoogleFont" respects the user's privacy and allows to serve the API reference offline.
## Installation
`npm install nestjs-redox`
### Standalone
By default NestJSRedox automatically loads the redoc bundle from a CDN. If you want to host it yourself, install redoc via `npm install redoc` and set `standalone` in RedoxOptions parameter to true. An additional fix replaces the redoc logo URL with a local saved image.
See chapter "setup".
## Setup
In your main.ts file, before calling app.listen() insert the module setup:
```typescript
import { NestJSRedoxOptions } from 'nestjs-redox';
/** example swagger config **/
const swaggerConfig = new DocumentBuilder()
.setTitle('API reference')
.setDescription('Some description')
.setVersion('1.0.0')
.addBearerAuth()
.addSecurity('roles', {
type: 'http',
scheme: 'bearer',
})
.build();
/**
* official supported options by Redoc
*/
const redocOptions: RedocOptions = {
requiredPropsFirst: true,
};
/**
* Redox options
*/
const redoxOptions: NestJSRedoxOptions = {
useGlobalPrefix: true,
disableGoogleFont: true,
standalone: true,
auth: {
enabled: true,
users: {
user1: 'user1',
user2: 'user2',
},
},
};
/**
* create swagger document
*/
const document = SwaggerModule.createDocument(app, swaggerConfig, {
ignoreGlobalPrefix: false,
operationIdFactory: (controllerKey, methodKey) => methodKey,
});
/**
* Initialize NestjsRedoxModule
*/
NestjsRedoxModule.setup('reference', app as any, document, redoxOptions, redocOptions);
```
If you like this package give it a star ;)
### Options
For supported options see [Options](https://github.com/julianpoemp/nestjs-redox/blob/main/libs/nestjs-redox/src/lib/types.ts).
## Changelog
See [Changelog](https://github.com/julianpoemp/nestjs-redox/blob/main/libs/nestjs-redox/CHANGELOG.md).
## Development
Clone this repository and run `npm install`. You find the library under `libs/nestjs-redox` and the demo apps under `apps/demo-express`or `apps/demo-fastify`. Please run `npm run format` before commiting and make sure to use valid commit messages (see chapter Contributing).
## E2E Testing
Run `npm run test` to run e2e tests.
## Contributing
If you want to contribute please fork this repository and send a pull request. The commit messages must be formatted after the conventional changelog angular theme. Following scopes are allowed: "nestjs-redox", "demo-express", "demo-fastify" and "project" for changes that affect the whole project.