Skip to content
This repository was archived by the owner on Mar 8, 2025. It is now read-only.

A lite way for building swagger in expressJs πŸš€πŸš€πŸš€

License

Notifications You must be signed in to change notification settings

thecodeorigin/lite-express-swagger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Lite Express Swagger

Description


Lite Express Swagger is a package built by typescript and an open-source project that helps expressjs application to easily build swagger documentation.
This package provides flexibility and lite functionality to build swagger document and not using the raw json to build it.

Getting started


Firstly you need to initialize your documentation by defining in this way:

const document = new DocumentBuilder()
    .setInfo({
        title: 'Express application',
        version: '1.0',
        // Below fields are optional
        description: 'Description';
        termsOfService: 'http://swagger.io/terms/';
        contact: {
            name: 'Phu';
            email: '[email protected]';
        };
        license: {
            name: 'Apache 2.0';
            url: 'http://www.apache.org/licenses/LICENSE-2.0.html';
        };
    })

About

A lite way for building swagger in expressJs πŸš€πŸš€πŸš€

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published