Search icon CANCEL
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Conferences
Free Learning
Arrow right icon
Arrow up icon
GO TO TOP
Nest.js: A Progressive Node.js Framework

You're reading from   Nest.js: A Progressive Node.js Framework Hit the ground running with Nest.js

Arrow left icon
Product type Paperback
Published in Nov 2019
Publisher Packt
ISBN-13 9781800204737
Length 317 pages
Edition 1st Edition
Languages
Tools
Arrow right icon
Authors (6):
Arrow left icon
Greg Magolan Greg Magolan
Author Profile Icon Greg Magolan
Greg Magolan
Patrick Housley Patrick Housley
Author Profile Icon Patrick Housley
Patrick Housley
Backstop Media LLC Backstop Media LLC
Author Profile Icon Backstop Media LLC
Backstop Media LLC
Adrien de Peretti Adrien de Peretti
Author Profile Icon Adrien de Peretti
Adrien de Peretti
Jay Bell Jay Bell
Author Profile Icon Jay Bell
Jay Bell
David Guijarro David Guijarro
Author Profile Icon David Guijarro
David Guijarro
+2 more Show less
Arrow right icon
View More author details
Toc

Table of Contents (16) Chapters Close

Preface
1. Introduction FREE CHAPTER 2. Overview 3. Nest.js authentication 4. Dependency Injection system of Nest.js 5. TypeORM 6. Sequelize 7. Mongoose 8. Web sockets 9. Microservices 10. Routing and request handling in Nest.js 11. OpenAPI (Swagger) Specification 12. Command Query Responsibility Separation (CQRS) 13. Architecture 14. Testing 15. Server-side Rendering with Angular Universal

Saving the swagger document

We have covered all of the available decorators in the Nest.js swagger module and the decorators already available in Nest.js to produce a swagger document and expose the swagger UI. This works great when your APIs are primarily used by developers in their own projects or when testing the APIs on a local development server or in a staging environment. For APIs that are primarily used for a specific front-end application, you may not wish to expose the swagger UI for the general public to be able to use. In such a case, you can still produce a swagger document for storage and use it on your own or your teams other projects.

To accomplish this, we will write a new Typescript file that can be executed as part of a build chain. We will use the fs-extras NodeJS module to make writing our file to disk much simpler.

import * as fs from 'fs-extra';

async function writeDoc() {
    const app = await NestFactory.create(AppModule);
    const document = SwaggerModule...
lock icon The rest of the chapter is locked
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at €18.99/month. Cancel anytime