https://github.com/simplify-framework/converter

Convert from Serverless Framework's YAML definition to OpenAPI 3.0 specs that is compatible with Simplify Framework specs definition.
https://github.com/simplify-framework/converter

converter javascript nodejs openapi serverless-framework simplify-framework simplify-specs yaml

Last synced: 22 days ago
JSON representation

Convert from Serverless Framework's YAML definition to OpenAPI 3.0 specs that is compatible with Simplify Framework specs definition.

• Host: GitHub
• URL: https://github.com/simplify-framework/converter
• Owner: simplify-framework
• License: apache-2.0
• Created: 2020-04-21T14:03:52.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-03-31T21:56:42.000Z (almost 4 years ago)
• Last Synced: 2024-12-24T02:35:22.821Z (about 2 months ago)
• Topics: converter, javascript, nodejs, openapi, serverless-framework, simplify-framework, simplify-specs, yaml
• Language: JavaScript
• Homepage:
• Size: 58.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simplify Framework - Converter

  

![NPM Downloads](https://img.shields.io/npm/dw/simplify-converter)

![Package Version](https://img.shields.io/github/package-json/v/simplify-framework/converter?color=green)

This is a facility toolkit to support converting from Serverless framework's YAML definition to OpenAPI 3.0 specs that compatible with Simplify specs definition.

*Node.js-based command line toolkit requires node >= 8.x version or later.*

```

npm install -g simplify-converter

simplify-converter -i serverless.yaml -o .

```

Serverless Framework example: `serverless.yaml`

```yaml

# For full config options, check the docs:

#    docs.serverless.com

#    https://serverless.com/framework/docs/providers/aws/guide/serverless.yml/

#

# Happy Coding!

service: pets-service

# You can pin your service to only deploy with a specific Serverless version

# Check out our docs for more details

# frameworkVersion: "=X.X.X"

provider:

  name: aws

  runtime: nodejs12.x

  iamRoleStatements:

    - Effect: 'Allow'

      Action:

        - 's3:ListBucket'

      Resource:

        Fn::Join:

          - ''

          - - 'arn:aws:s3:::'

            - Ref: SharedFileResourcesBucket

    - Effect: 'Allow'

      Action:

        - 's3:PutObject'

      Resource:

        Fn::Join:

          - ''

          - - 'arn:aws:s3:::'

            - Ref: SharedFileResourcesBucket

            - '/*'

functions:

  get-pets-list:

    handler: src/handlers/index.handler

    events:

      - http:

          method: get

          path: pets

          description: Retrieve list of pets.

      - schedule: rate(2 hours)

      - cloudwatchLog: '/aws/lambda/hello'

      - sns:

          arn: arn:aws:sns:${self:provider.region}:${self:provider.accountId, '01234567890'}:topicname

          topicName: topicname-${self:provider.accountId, '01234567890'}-${self:provider.region}

plugins:

  - serverless-webpack

  - serverless-plugin-log-retention

resources:

  Resources:

    SharedFileResourcesBucket:

      Type: AWS::S3::Bucket

      Properties:

        BucketName: ${self:service}-bucket

        CorsConfiguration:

          CorsRules:

            - AllowedMethods:

                - GET

                - POST

              AllowedOrigins:

                - "*"

```

> Resource dependancy will be generated into one CloudFormation YAML stack and be able to manage it independently.

## HOW TO: Deploy external resources

  Simplify Converter generates a set of managed stacks including Simplify SDK script to be able to run by npm commands:

  ```bash

  cd resources

  npm install

  npm run stack-deploy

  ...

  npm run stack-destroy

  ```

> Your AWS Credentials must be configured manually to have permission for deploying external resources.

***Simplify Framework @Copyright 2020***