@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
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
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.