@swarmjs/swagger
v1.2.5
Published
Swagger plugin for SwarmJS
Downloads
2
Readme
Table Of Contents
About The Project
The Swagger plugin will add dynamic Swagger file generation, directly into your project. Simply add this plugin, and then go to https://<your_api_url>/v1
.
Built With
- TypeScript@4
Getting Started
Installation
yarn add @swarmjs/swagger
or
npm install --save @swarmjs/swagger
Usage
import { Swarm } from '@swarmjs/core'
import { SwaggerPlugin } from '@swarmjs/swagger'
// Create instance
const app = new Swarm()
// Use the plugin
app.use(SwaggerPlugin, {
controllerName: 'SwaggerPlugin', // Customize controller name into your API
access: null // Restricts access to logged users, based on SwarmJS ACL
})
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
- Please make sure you check your spelling and grammar.
- Create individual PR for each suggestion.
- Please also read through the Code Of Conduct before posting your first idea as well.
Creating A Pull Request
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE for more information.