https://github.com/onebeyond/swagger-endpoint-validator

Validator around swagger generator
https://github.com/onebeyond/swagger-endpoint-validator

hacktoberfest

Last synced: about 2 months ago
JSON representation

Validator around swagger generator

• Host: GitHub
• URL: https://github.com/onebeyond/swagger-endpoint-validator
• Owner: onebeyond
• License: mit
• Created: 2019-10-28T09:35:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-16T10:08:09.000Z (12 months ago)
• Last Synced: 2025-04-12T01:14:20.030Z (about 2 months ago)
• Topics: hacktoberfest
• Language: JavaScript
• Homepage: https://onebeyond.github.io/swagger-endpoint-validator/
• Size: 1.76 MB
• Stars: 7
• Watchers: 10
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        

[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)

[![CI](https://github.com/guidesmiths/swagger-endpoint-validator/actions/workflows/ci.yml/badge.svg)](https://github.com/guidesmiths/swagger-endpoint-validator/actions/workflows/ci.yml)

[![CD](https://github.com/guidesmiths/swagger-endpoint-validator/actions/workflows/cd.yml/badge.svg)](https://github.com/guidesmiths/swagger-endpoint-validator/actions/workflows/cd.yml)

[![Maintainability](https://api.codeclimate.com/v1/badges/08258af73b9f938e544a/maintainability)](https://codeclimate.com/github/onebeyond/swagger-endpoint-validator/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/08258af73b9f938e544a/test_coverage)](https://codeclimate.com/github/onebeyond/swagger-endpoint-validator/test_coverage)

# swagger-endpoint-validator

![npm](https://img.shields.io/npm/v/swagger-endpoint-validator)

A validator of API endpoints to check that input and/or output match with the swagger specification for the API.

This is based on [express-swagger-generator](https://www.npmjs.com/package/express-swagger-generator), so it is important that each endpoints is properly documented so that the library can do the validation.

## Installation

```bash

npm install --save swagger-endpoint-validator

```

## Methods

### init(app: ExpressApp, options: ConfigFile)

```js

await validator.init(app, options);

```

where:

  - `app` is the Express app instance.

  - `options` is the configuration object used by the validator.

## TO DO!

Improve this doc.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Kevin Julián Martínez Escobar
🐛 💻 📖 🤔 👀 ⚠️

      
Sara Hernández
🐛 💻

      
Irene Mateo Herrero
💻

      
Íñigo Marquínez Prado
🐛 💻 📖 🤔 🚧 👀 ⚠️

      
Ulises Gascón
🐛 💻 📖 🤔 🚧 👀 ⚠️

      
David Miguel Yusta
💻 ⚠️

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!