{"id":21518563,"url":"https://github.com/simplify-framework/converter","last_synced_at":"2026-05-04T13:37:33.925Z","repository":{"id":53279897,"uuid":"257614934","full_name":"simplify-framework/converter","owner":"simplify-framework","description":"Convert from Serverless Framework's YAML definition to OpenAPI 3.0 specs that is compatible with Simplify Framework specs definition.","archived":false,"fork":false,"pushed_at":"2021-03-31T21:56:42.000Z","size":60,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-25T04:35:02.161Z","etag":null,"topics":["converter","javascript","nodejs","openapi","serverless-framework","simplify-framework","simplify-specs","yaml"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simplify-framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"open_collective":"duong-dinh-cuong"}},"created_at":"2020-04-21T14:03:52.000Z","updated_at":"2020-05-24T16:44:58.000Z","dependencies_parsed_at":"2022-08-28T15:51:48.048Z","dependency_job_id":null,"html_url":"https://github.com/simplify-framework/converter","commit_stats":null,"previous_names":["aws-simplify/converter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplify-framework%2Fconverter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplify-framework%2Fconverter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplify-framework%2Fconverter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplify-framework%2Fconverter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simplify-framework","download_url":"https://codeload.github.com/simplify-framework/converter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244072406,"owners_count":20393609,"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":["converter","javascript","nodejs","openapi","serverless-framework","simplify-framework","simplify-specs","yaml"],"created_at":"2024-11-24T00:53:02.294Z","updated_at":"2025-10-19T12:04:30.901Z","avatar_url":"https://github.com/simplify-framework.png","language":"JavaScript","funding_links":["https://opencollective.com/duong-dinh-cuong"],"categories":[],"sub_categories":[],"readme":"# Simplify Framework - Converter\n  \n![NPM Downloads](https://img.shields.io/npm/dw/simplify-converter)\n![Package Version](https://img.shields.io/github/package-json/v/simplify-framework/converter?color=green)\n\nThis is a facility toolkit to support converting from Serverless framework's YAML definition to OpenAPI 3.0 specs that compatible with Simplify specs definition.\n\n*Node.js-based command line toolkit requires node \u003e= 8.x version or later.*\n\n```\nnpm install -g simplify-converter\nsimplify-converter -i serverless.yaml -o .\n```\n\nServerless Framework example: `serverless.yaml`\n\n```yaml\n# For full config options, check the docs:\n#    docs.serverless.com\n#    https://serverless.com/framework/docs/providers/aws/guide/serverless.yml/\n#\n# Happy Coding!\n\nservice: pets-service\n\n# You can pin your service to only deploy with a specific Serverless version\n# Check out our docs for more details\n# frameworkVersion: \"=X.X.X\"\n\nprovider:\n  name: aws\n  runtime: nodejs12.x\n  iamRoleStatements:\n    - Effect: 'Allow'\n      Action:\n        - 's3:ListBucket'\n      Resource:\n        Fn::Join:\n          - ''\n          - - 'arn:aws:s3:::'\n            - Ref: SharedFileResourcesBucket\n    - Effect: 'Allow'\n      Action:\n        - 's3:PutObject'\n      Resource:\n        Fn::Join:\n          - ''\n          - - 'arn:aws:s3:::'\n            - Ref: SharedFileResourcesBucket\n            - '/*'\n\nfunctions:\n  get-pets-list:\n    handler: src/handlers/index.handler\n    events:\n      - http:\n          method: get\n          path: pets\n          description: Retrieve list of pets.\n      - schedule: rate(2 hours)\n      - cloudwatchLog: '/aws/lambda/hello'\n      - sns:\n          arn: arn:aws:sns:${self:provider.region}:${self:provider.accountId, '01234567890'}:topicname\n          topicName: topicname-${self:provider.accountId, '01234567890'}-${self:provider.region}\nplugins:\n  - serverless-webpack\n  - serverless-plugin-log-retention\n\nresources:\n  Resources:\n    SharedFileResourcesBucket:\n      Type: AWS::S3::Bucket\n      Properties:\n        BucketName: ${self:service}-bucket\n        CorsConfiguration:\n          CorsRules:\n            - AllowedMethods:\n                - GET\n                - POST\n              AllowedOrigins:\n                - \"*\"\n```\n\n\u003e Resource dependancy will be generated into one CloudFormation YAML stack and be able to manage it independently.\n\n## HOW TO: Deploy external resources\n  Simplify Converter generates a set of managed stacks including Simplify SDK script to be able to run by npm commands:\n\n  ```bash\n  cd resources\n  npm install\n  npm run stack-deploy\n  ...\n  npm run stack-destroy\n  ```\n\n\u003e Your AWS Credentials must be configured manually to have permission for deploying external resources.\n\n***Simplify Framework @Copyright 2020***\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplify-framework%2Fconverter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplify-framework%2Fconverter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplify-framework%2Fconverter/lists"}