https://github.com/feathersjs-ecosystem/feathers-swagger

Add documentation to your FeatherJS services and feed them to Swagger UI.
https://github.com/feathersjs-ecosystem/feathers-swagger

feathersjs

Last synced: 3 months ago
JSON representation

Add documentation to your FeatherJS services and feed them to Swagger UI.

• Host: GitHub
• URL: https://github.com/feathersjs-ecosystem/feathers-swagger
• Owner: feathersjs-ecosystem
• License: mit
• Created: 2014-02-16T06:08:29.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-04-24T05:11:55.000Z (7 months ago)
• Last Synced: 2024-08-01T09:02:59.217Z (3 months ago)
• Topics: feathersjs
• Language: JavaScript
• Homepage:
• Size: 1.99 MB
• Stars: 225
• Watchers: 8
• Forks: 63
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/contributing.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-feathersjs - feathers-swagger - Add documentation to your Feathers services and feed them to Swagger UI. (configure) (Plugins / Documentation)

README

        
# feathers-swagger

[![CI](https://github.com/feathersjs-ecosystem/feathers-swagger/actions/workflows/ci.yaml/badge.svg)](https://github.com/feathersjs-ecosystem/feathers-swagger/actions/workflows/ci.yaml)

[![Download Status](https://img.shields.io/npm/dm/feathers-swagger.svg?style=flat-square)](https://www.npmjs.com/package/feathers-swagger)

Add [OpenAPI](https://swagger.io/resources/open-api/) documentation to your Feathers services and optionally show them in the [Swagger UI](https://swagger.io/tools/swagger-ui/).

You can also add custom methods to feathers services that will be available as rest routes but not via the feathers client.

Checkout the [Documentation](https://feathersjs-ecosystem.github.io/feathers-swagger) for further information.

[Changelog](./docs/CHANGELOG.md)

## License

Copyright (c) 2016 - 2023

Licensed under the [MIT license](LICENSE).