https://github.com/metadevpro/zafiro-openapi3

ZafiroJS plugin for exposing OpenAPI v. 3.0 compliant API contracts
https://github.com/metadevpro/zafiro-openapi3

openapi plugin reflection-api zafirojs

Last synced: 9 months ago
JSON representation

ZafiroJS plugin for exposing OpenAPI v. 3.0 compliant API contracts

• Host: GitHub
• URL: https://github.com/metadevpro/zafiro-openapi3
• Owner: metadevpro
• License: mit
• Created: 2018-01-05T17:20:46.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-06-01T23:58:41.000Z (over 5 years ago)
• Last Synced: 2025-05-08T00:13:33.428Z (9 months ago)
• Topics: openapi, plugin, reflection-api, zafirojs
• Language: TypeScript
• Size: 177 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# zafiro-openapi3

[![npm version](https://badge.fury.io/js/zafiro-openapi3.svg)](http://badge.fury.io/js/zafiro-openapi3)

[![Build Status](https://travis-ci.org/metadevpro/zafiro-openapi3.svg?branch=master)](https://travis-ci.org/metadevpro/zafiro-openapi3)

[![Dependencies](https://david-dm.org/metadevpro/zafiro-openapi3.svg)](https://david-dm.org/metadevpro/zafiro-openapi3#info=dependencies)

[![img](https://david-dm.org/metadevpro/zafiro-openapi3/dev-status.svg)](https://david-dm.org/metadevpro/zafiro-openapi3/#info=devDependencies)

[![Known Vulnerabilities](https://snyk.io/test/github/metadevpro/zafiro-openapi3/badge.svg)](https://snyk.io/test/github/metadevpro/zafiro-openapi3)

[![Greenkeeper badge](https://badges.greenkeeper.io/metadevpro/zafiro-openapi3.svg)](https://greenkeeper.io/)

Zafiro plugin providing OpenAPI v 3.x service description.

## Installation

```sh

npm install zafiro-openapi3 reflect-metadata

```

> :warning: **The `reflect-metadata` polyfill should be imported only once in your entire application** because the Reflect object is mean to be a global singleton. More details about this can be found [here](https://github.com/inversify/InversifyJS/issues/262#issuecomment-227593844).

## The basics

First you need to declare an entity:

```ts

``