Skip to content

Add oas30 and yaml files to upload #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
babyhuey wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add oas30 and yaml files to upload #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b8e0868
Adding yaml and json to oas30 and swagger docs
Feb 26, 2019
aeef5be
Update gitignore
Feb 26, 2019
4583005
Update gitignore
Feb 26, 2019
55a348d
Add new options from serverless to allow choice of openapi and yaml f…
Feb 27, 2019
30574c5
Fix Readme to not use file type
Feb 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,5 @@ typings/
# dotenv environment variables file
.env

# intellij files
.idea/
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ plugins:
custom:
swaggerDestinations:
s3BucketName: 'bucket-name'
s3KeyName: 'swagger/api.json'
s3KeyName: 'swagger/api'
# optional, default: private
acl: public-read
#optional settings to upload yaml and openapi files.
uploadOpenAPI: true
uploadYaml: true
```
6 changes: 3 additions & 3 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "serverless-export-swagger",
"version": "2.0.0",
"version": "2.0.1",
"description": "export swagger definition to s3 ",
"main": "src/index.js",
"scripts": {
Expand Down Expand Up @@ -30,6 +30,6 @@
"eslint-plugin-react": "^7.5.1"
},
"dependencies": {
"aws-sdk": "^2.385.0"
"aws-sdk": "^2.410.0"
}
}
79 changes: 73 additions & 6 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,57 @@ const getSwagger = async function getSwagger(apiName, stage, region, creds) {
return swagger
}

const getSwaggerYaml = async function getSwagger(apiName, stage, region, creds) {
const ag = new AWS.APIGateway({
credentials: creds,
region,
})
const swaggeryaml = await ag.getExport({
exportType: 'swagger',
restApiId: apiName,
stageName: stage,
accepts: 'application/yaml',
parameters: {
extensions: 'integrations',
},
}).promise()
return swaggeryaml
}

const getOpenapi = async function getOpenapi(apiName, stage, region, creds) {
const ag = new AWS.APIGateway({
credentials: creds,
region,
})
const oas30 = await ag.getExport({
exportType: 'oas30',
restApiId: apiName,
stageName: stage,
accepts: 'application/json',
parameters: {
extensions: 'integrations',
},
}).promise()
return oas30
}

const getOpenapiYaml = async function getOpenapi(apiName, stage, region, creds) {
const ag = new AWS.APIGateway({
credentials: creds,
region,
})
const oas30yaml = await ag.getExport({
exportType: 'oas30',
restApiId: apiName,
stageName: stage,
accepts: 'application/yaml',
parameters: {
extensions: 'integrations',
},
}).promise()
return oas30yaml
}

const uploadSwaggerToS3 = async function uploadSwaggerToS3(swagger, bucket, key, region, creds) {
const s3 = new AWS.S3({
credentials: creds,
Expand All @@ -50,26 +101,42 @@ const uploadSwaggerToS3 = async function uploadSwaggerToS3(swagger, bucket, key,
}).promise()
}

const getBucketAndKey = function getBucketAndKey(serverless) {
const getServerlessOptions = function getServerlessOptions(serverless) {
const bucket = serverless.service.custom.swaggerDestinations.s3BucketName
const key = serverless.service.custom.swaggerDestinations.s3KeyName
const openapi = serverless.service.custom.swaggerDestinations.uploadOpenAPI
const yaml = serverless.service.custom.swaggerDestinations.uploadYaml
if (!bucket || !key) {
throw new Error('ExportSwagger: Bucket name and key are required fields')
}
return { bucket, key }
};
return { bucket, key, openapi, yaml }
}

const exportApi = async function exportApi(serverless) {
const provider = serverless.getProvider('aws')
const awsCredentials = provider.getCredentials().credentials
const region = provider.getRegion()
const stage = provider.getStage()
const serviceName = serverless.service.getServiceName()
const { bucket, key } = getBucketAndKey(serverless)
const { bucket, key, openapi, yaml } = getServerlessOptions(serverless)
const apiName = await getApiName(serviceName, stage, region, awsCredentials)
const swagger = await getSwagger(apiName, stage, region, awsCredentials)

@rrahul963 rrahul963 Feb 27, 2019

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@babyhuey i think we should check for the new options here itself

if (openapi) {
  if (yaml) {
    //get yaml openapi and upload it
  } else {
    //get json openapi and upload it
  }
} else {
  if (yaml) {
    //get swagger yaml and upload it
  } else {
    //get swagger json and upload it
  }
}

@babyhuey babyhuey Mar 12, 2019

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. I set it up the way I did because I wanted all 4 styles uploaded. If I understand this correctly, it will only upload one file, correct?

@rrahul963 rrahul963 Mar 17, 2019

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes my update will upload only one version, is there a reason why one would need all the versions uploaded?

await uploadSwaggerToS3(swagger, bucket, key, region, awsCredentials)
serverless.cli.consoleLog('ExportSwagger: File uploaded to s3.')
const swaggeryaml = await getSwaggerYaml(apiName, stage, region, awsCredentials)
const oas30 = await getOpenapi(apiName, stage, region, awsCredentials)
const oas30yaml = await getOpenapiYaml(apiName, stage, region, awsCredentials)
const swaggerKey = `${key}-swagger.json`
await uploadSwaggerToS3(swagger, bucket, swaggerKey, region, awsCredentials)
if (typeof openapi !== 'undefined') {

@rrahul963 rrahul963 Mar 17, 2019

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rather than checking for !== 'undefined' can you change this to === true.. do this everywhere you are checking

const oas30Key = `${key}-oas30.json`
await uploadSwaggerToS3(oas30, bucket, oas30Key, region, awsCredentials) }
if (typeof yaml !== 'undefined') {
const swaggerYamlKey = `${key}-swagger.yaml`
await uploadSwaggerToS3(swaggeryaml, bucket, swaggerYamlKey, region, awsCredentials) }
if (typeof openapi !== 'undefined' && typeof yaml !== 'undefined') {
const oas30YamlKey = `${key}-oas30.yaml`
await uploadSwaggerToS3(oas30yaml, bucket, oas30YamlKey, region, awsCredentials) }

serverless.cli.consoleLog('ExportSwagger: Files uploaded to s3.')
}

/**
Expand Down