{"id":21268853,"url":"https://github.com/squeezerio/squeezer-swagger","last_synced_at":"2025-08-01T14:06:25.336Z","repository":{"id":57368500,"uuid":"100361951","full_name":"SqueezerIO/squeezer-swagger","owner":"SqueezerIO","description":"Swagger Docs Serverless Plugin. This plugin enables Swagger API Documentation support within the Squeezer Framework.","archived":false,"fork":false,"pushed_at":"2017-11-16T09:17:46.000Z","size":421,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-09T00:33:54.500Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SqueezerIO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-15T09:31:10.000Z","updated_at":"2018-10-22T18:16:29.000Z","dependencies_parsed_at":"2022-09-05T19:20:28.007Z","dependency_job_id":null,"html_url":"https://github.com/SqueezerIO/squeezer-swagger","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SqueezerIO%2Fsqueezer-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SqueezerIO%2Fsqueezer-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SqueezerIO%2Fsqueezer-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SqueezerIO%2Fsqueezer-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SqueezerIO","download_url":"https://codeload.github.com/SqueezerIO/squeezer-swagger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243725529,"owners_count":20337667,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-21T08:06:35.761Z","updated_at":"2025-03-15T11:42:29.050Z","avatar_url":"https://github.com/SqueezerIO.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# squeezer-swagger\nSwagger API Docs Squeezer Plugin  . This plugin enables Swagger API Docs support within the Squeezer Framework.\n\n[![Squeezer.IO](https://cdn.rawgit.com/SqueezerIO/squeezer/9a010c35/docs/gitbook/images/badge.svg)](https://Squeezer.IO)\n[![Build Status](https://travis-ci.org/SqueezerIO/squeezer-swagger.svg?branch=master)](https://travis-ci.org/SqueezerIO/squeezer-swagger)\n[![npm version](https://badge.fury.io/js/squeezer-swagger.svg)](https://badge.fury.io/js/squeezer-swagger)\n[![DUB](https://img.shields.io/dub/l/vibe-d.svg)]()\n\n### Installation\n\n`cd PROJECT_DIR`\n\n`npm i squeezer-swagger --save`\n\n### Activate the plugin\n\n*PROJECT_DIR/squeezer.yml*\n\n```yaml\nplugins:\n  - name: squeezer-swagger\n    path: node_modules\n```\n\n### Squeezer Global Config\n\n```\n.\nPROJECT_DIR\n└─squeezer.yml\n```\n\n`squeezer.yml` :\n\n```yaml\nswagger:\n  info:\n    title: My API Docs\n    description: detailed docs for my API endpoints\n  definitions:\n    ErrorResponse:\n      type: object\n      properties:\n        message:\n          type: string\n          default: error message\n        code:\n          type: string\n          default: error code\n        statusCode:\n          type: integer\n          default: 400\n```          \n\n\n### Functions Configs\n\nYou can add paths and definitions for a specific function on your project.\n\n```\nPROJECT_DIR\n└─services/\n    └── hello\n      └──function1 \n        ├── handler.js\n        └── sqzueezer.yml\n```\n\n`squeezer.yml` :\n\n```yaml\nswagger:\n  paths:\n    /pet:\n      post:\n        tags:\n          - \"pet\"\n        summary: \"Add a new pet to the store\"\n        description: \"long description\"\n        operationId: \"addPet\"\n        consumes:\n          - \"application/json\"\n          - \"application/xml\"\n        produces:\n          - \"application/xml\"\n          - \"application/json\"\n  definitions:\n    Pet:\n      type: \"object\"\n      required:\n        - \"name\"\n        - \"photoUrls\"\n      properties:\n        id:\n          type: \"integer\"\n          format: \"int64\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqueezerio%2Fsqueezer-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsqueezerio%2Fsqueezer-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqueezerio%2Fsqueezer-swagger/lists"}