https://github.com/zeromake/egg-swagger

https://github.com/zeromake/egg-swagger

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/zeromake/egg-swagger
• Owner: zeromake
• License: mit
• Created: 2019-05-19T13:54:20.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-03-31T01:20:28.000Z (over 3 years ago)
• Last Synced: 2024-11-20T17:42:54.558Z (about 1 month ago)
• Language: TypeScript
• Size: 974 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# egg-swagger

[![NPM version][npm-image]][npm-url]

[![build status][travis-image]][travis-url]

[![Test coverage][codecov-image]][codecov-url]

[![David deps][david-image]][david-url]

[![Known Vulnerabilities][snyk-image]][snyk-url]

[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/@zeromake%2Fegg-swagger.svg?style=flat-square

[npm-url]: https://npmjs.org/package/@zeromake%2Fegg-swagger

[travis-image]: https://travis-ci.com/zeromake/egg-swagger.svg?branch=master

[travis-url]: https://travis-ci.com/zeromake/egg-swagger

[codecov-image]: https://img.shields.io/codecov/c/github/zeromake/egg-swagger.svg?style=flat-square

[codecov-url]: https://codecov.io/github/zeromake/egg-swagger?branch=master

[david-image]: https://img.shields.io/david/zeromake/egg-swagger.svg?style=flat-square

[david-url]: https://david-dm.org/zeromake/egg-swagger

[snyk-image]: https://snyk.io/test/npm/@zeromake%2Fegg-swagger/badge.svg?style=flat-square

[snyk-url]: https://snyk.io/test/npm/@zeromake%2Fegg-swagger

[download-image]: https://img.shields.io/npm/dm/@zeromake%2Fegg-swagger.svg?style=flat-square

[download-url]: https://npmjs.org/package/@zeromake%2Fegg-swagger

## Install

```bash

$ npm i egg-swagger --save

```

## Usage

```js

// {app_root}/config/plugin.js

exports.swagger = {

  enable: true,

  package: '@zeromake/egg-swagger',

};

```

## Configuration

```js

// {app_root}/config/config.default.js

exports.swagger = {

};

```

see [config/config.default.js](config/config.default.js) for more detail.

## Example

## Questions & Suggestions

Please open an issue [here](https://github.com/zeromake/egg-swagger/issues).

## License

[MIT](LICENSE)