@amplication/plugin-swagger-apibody
Advanced tools
Add Description of Routes and Entity properties to the REST-API Documentation
Add Description of Routes and Entity properties to the REST-API Documentation.
@common.Post()
@swagger.ApiCreatedResponse({ type: User })
@swagger.ApiForbiddenResponse({ type: errors.ForbiddenException })
@swagger.ApiBody({
type: UserCreateInput,
}) /// add this line to every post and update controller
async create(@common.Body() data: UserCreateInput): Promise<User> {
The plugin adds the details of the type of the body to the Create and Update methods in each controller.
no configuration required
buildRunning npm run build will bundle your plugin with Webpack for production.
add this plugin to the generated code to get extra information on your documentation.
FAQs
Add Description of Routes and Entity properties to the REST-API Documentation
The npm package @amplication/plugin-swagger-apibody receives a total of 4,287 weekly downloads. As such, @amplication/plugin-swagger-apibody popularity was classified as popular.
We found that @amplication/plugin-swagger-apibody demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.