https://github.com/thecodeorigin/lite-express-swagger

A lite way for building swagger in expressJs 🚀🚀🚀
https://github.com/thecodeorigin/lite-express-swagger

Last synced: 10 months ago
JSON representation

A lite way for building swagger in expressJs 🚀🚀🚀

• Host: GitHub
• URL: https://github.com/thecodeorigin/lite-express-swagger
• Owner: thecodeorigin
• License: mit
• Created: 2021-08-31T13:20:54.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-09-22T17:03:04.000Z (over 4 years ago)
• Last Synced: 2023-03-09T23:32:20.481Z (almost 3 years ago)
• Language: TypeScript
• Homepage:
• Size: 155 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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:

```javascript

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: 'test@gmail.com';

        };

        license: {

            name: 'Apache 2.0';

            url: 'http://www.apache.org/licenses/LICENSE-2.0.html';

        };

    })

```