Search icon
Subscription
0
Cart icon
Close icon
You have no products in your basket yet
Arrow left icon
All Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Newsletters
Free Learning
Arrow right icon
Nest.js: A Progressive Node.js Framework

You're reading from  Nest.js: A Progressive Node.js Framework

Product type Book
Published in Nov 2019
Publisher Packt
ISBN-13 9781800204737
Pages 317 pages
Edition 1st Edition
Languages
Authors (5):
Greg Magolan Greg Magolan
Profile icon Greg Magolan
Patrick Housley Patrick Housley
Profile icon Patrick Housley
Adrien de Peretti Adrien de Peretti
Profile icon Adrien de Peretti
Jay Bell Jay Bell
Profile icon Jay Bell
David Guijarro David Guijarro
Profile icon David Guijarro
View More author details

Table of Contents (16) Chapters

Preface
1. Introduction 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

API metadata decorators

If you work through any Nest.js project and properly decorate all the controllers and controller methods with the decorators we have covered so far, the swagger document the Nest.js swagger module produces will have every technical detail a user of the APIs would need to understand and use the APIs. The last two decorators we will cover in this chapter simply provide more metadata for the swagger document. The swagger UI will use this metadata to produce a cleaner UI, but functionality will not change.

The first decorator we will cover is @ApiOperation. Don’t confuse this decorator with the HTTP method decorators like @Put. This decorator is used to provide a title, description, and unique identifier called an operationId for individual controller methods.

@Put('comments/:commentId')
@ApiOperation({
    title: 'Comment Update',
    description: 'Updates a specific comment with new content',
    operationId: 'commentUpdate...
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 $15.99/month. Cancel anytime}