# @didik-mulyadi/nodejs-api-doc
> A nodejs library to generate the API Docs with multiple UI
Latest version **1.2.0** (published 2023-08-17) · MIT license · 0 weekly downloads
## Install
```sh
npm install @didik-mulyadi/nodejs-api-doc
pnpm add @didik-mulyadi/nodejs-api-doc
yarn add @didik-mulyadi/nodejs-api-doc
bun add @didik-mulyadi/nodejs-api-doc
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities.
Warnings: low downloads.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.2.0 |
| Published | 2023-08-17 |
| First published | 2023-08-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 154.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Didik Mulyadi |
| Maintainers | didikmulyadi |
| Keywords | api-docs, api-documentation, swagger, redoc, stoplight, nodejs, nestjs-api-doc, nodejs-api-doc |
## Links
- npm: https://www.npmjs.com/package/@didik-mulyadi/nodejs-api-doc
- Repository: https://github.com/didikmulyadi/nodejs-api-doc
- Issues: https://github.com/didikmulyadi/nodejs-api-doc/issues
- npm.io page: https://npm.io/package/@didik-mulyadi/nodejs-api-doc
## Alternatives
- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads
## Recent versions
- 1.2.0 (latest) — 2023-08-17
- 1.1.0 — 2023-08-16
- 1.0.3 — 2023-08-15
- 1.0.2 — 2023-08-14
- 1.0.1 — 2023-08-14
- 1.0.0 — 2023-08-14
## README
⚡️@didik-mulyadi/nodejs-api-doc
A package to generate the API docs with multiple UI based on the open API file.
Bug report ·
Feature request
This package already supports NestJS and ExpressJS.
At this point, we are focusing on adding examples with many js-doc libraries. In the future, we will create our open API doc generation, "One Code for All Frameworks", but don't worry we are still making it support with other libraries.
## Installation 🚀
Install `@didik-mulyadi/nodejs-api-doc` using pnpm/npm/yarn:
```bash
pnpm add @didik-mulyadi/nodejs-api-doc
# OR
npm install @didik-mulyadi/nodejs-api-doc
# OR
yarn add @didik-mulyadi/nodejs-api-doc
```
## Usage 💻
After we set up the package correctly, we can switch the UI in your docs with this.
For example, your API doc location is `http://localhost:3000/docs
1. Use Swagger UI, `http://localhost:3000/docs?ui=swagger`
2. Use Stoplight UI, `http://localhost:3000/docs?ui=stoplight`
3. Use Redoc UI, `http://localhost:3000/docs?ui=redoc`
For code examples, see the `examples` directory or [click](https://github.com/didikmulyadi/nodejs-api-doc/tree/main/examples).
## Compatibility ⚙️
This package supports any package/library that returns the open API object. These are tested framework and library that is compatible with our package:
| Library | Support |
| -------------------------------------------------------------------------------------- | ------- |
| Nest JS + Fastify with [@nestjs/swagger](https://docs.nestjs.com/openapi/introduction) | ✅ |
| Nest JS + Express with [@nestjs/swagger](https://docs.nestjs.com/openapi/introduction) | ✅ |
| Express with [swagger-jsdoc](https://www.npmjs.com/package/swagger-jsdoc) | ✅ |
## Implementation 💻
Here's an example of how to use this package:
### nodejs-api-doc with Nest Fastify + @nest/swagger
Step:
1. Modify your `src/main.ts` with the below steps
2. Create a swagger config with `new DocumentBuilder()`
3. Generate open API document object with `SwaggerModule.createDocument(app, config)`
4. Setup nodejs-api-doc with `new NestApiDoc`
5. Start nodejs-api-doc with `nestApiDoc.start()`
```typescript
import { NestApiDoc } from '@didik-mulyadi/nodejs-api-doc'
async function bootstrap() {
const app = await NestFactory.create(
AppModule,
new FastifyAdapter()
)
// swagger
const config = new DocumentBuilder()
.setTitle('Node.js API Docs')
.setDescription('This API provides ...')
.setVersion('0.0.1')
.build()
const document = SwaggerModule.createDocument(app, config)
// nodejs-api-doc
const nestApiDoc = new NestApiDoc(app, document, {
defaultUI: 'stoplight',
customPath: '/docs',
})
nestApiDoc.start()
// Run the nestjs
await app.listen(8080, '0.0.0.0')
}
```
### nodejs-api-doc with Nest Express + @nest/swagger
Step:
1. Modify your `src/main.ts` with the below steps
2. Create a swagger config with `new DocumentBuilder()`
3. Generate open API document object with `SwaggerModule.createDocument(app, config)`
4. Setup nodejs-api-doc with `new NestApiDoc`
5. Start nodejs-api-doc with `nestApiDoc.start()`
```typescript
import { NestApiDoc } from '@didik-mulyadi/nodejs-api-doc'
async function bootstrap() {
const app = await NestFactory.create(AppModule)
// swagger
const config = new DocumentBuilder()
.setTitle('Node.js API Docs')
.setDescription('This API provides ...')
.setVersion('0.0.1')
.build()
const document = SwaggerModule.createDocument(app, config)
// nodejs-api-doc
const nestApiDoc = new NestApiDoc(app, document, {
defaultUI: 'stoplight',
customPath: '/docs',
})
nestApiDoc.start()
// Run the nestjs
await app.listen(8080, '0.0.0.0')
}
```
### nodejs-api-doc with Express + swagger-jsdoc
Step:
1. Modify your `server.js` or `main.js` with the below steps
2. Call the swagger-jsdoc `const document = swaggerJsdoc(options)`
3. Setup nodejs-api-doc `const expressApiDoc = new ExpressApiDoc(app, document)`
4. Start nodejs-api-doc `expressApiDoc.start()`
```typescript
const { ExpressApiDoc } = require('@didik-mulyadi/nodejs-api-doc')
const app = express()
...
// swagger-jsdoc
const options = {
definition: {
openapi: '3.1.0',
info: {
title: 'Node JS API Docs with Express',
version: '0.1.0',
description:
'This is a simple CRUD API application made with Express and documented with Swagger',
license: {
name: 'MIT',
url: 'https://spdx.org/licenses/MIT.html',
},
contact: {
name: 'Didik Mulyadi',
url: 'https://www.linkedin.com/in/didikmulyadi/',
email: 'didikmulyadi12@gmail.com',
},
},
servers: [
{
url: 'http://localhost:3000',
},
],
},
apis: ['./routes/*.js'],
}
const document = swaggerJsdoc(options)
// Nodejs-api-doc
const expressApiDoc = new ExpressApiDoc(app, document)
expressApiDoc.start()
app.listen(3000)
```
## Configuration options ⚙️
### Working with Helmet
#### Nest.JS Fastify Helmet
```typescript
import { NestApiDoc, helmetConfig } from '@didik-mulyadi/nodejs-api-doc';
async function bootstrap() {
...
await app.register(helmet, helmetConfig.nodeApiDocHelmetOption);
...
}
```
## Bugs or Requests 🐛
If you found any issues or have a good suggestion, feel free to open an [issue](https://github.com/didikmulyadi/nodejs-api-doc/issues/new)
## TODO
We are still updating this package, to make it more useful and easy to use. Here are the next that author wants to do
- [ ] Add readme for `bug_report.md`
- [ ] Add readme for `feature_request.md`
## Find Me 📖
Reach me on:
[](https://linkedin.com/in/https://www.linkedin.com/in/didikmulyadi/) [](https://medium.com/@https://didikmulyadi.medium.com/)
---
_Source: https://npm.io/package/@didik-mulyadi/nodejs-api-doc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._