Add a swagger endpoint to your EdgeAPI
Project description
@reapit-cdk/edge-api-swagger
Add a swagger endpoint to your EdgeAPI
Package Installation:
yarn add --dev @reapit-cdk/edge-api-swagger
# or
npm install @reapit-cdk/edge-api-swagger --save-dev
Usage
import { Stack, App } from 'aws-cdk-lib'
import { EdgeAPI, EdgeAPILambda, LambdaEndpoint, ProxyEndpoint } from '@reapit-cdk/edge-api'
import { Code, Runtime } from 'aws-cdk-lib/aws-lambda'
import { EdgeAPISwaggerEndpoint } from '@reapit-cdk/edge-api-swagger'
import { Certificate } from 'aws-cdk-lib/aws-certificatemanager'
import * as path from 'path'
const app = new App()
const stack = new Stack(app, 'stack-name')
const certificate = new Certificate(stack, 'certificate', {
domainName: 'example.org',
})
const api = new EdgeAPI(stack, 'api', {
certificate,
domains: ['example.org', 'example.com'],
devMode: false,
defaultEndpoint: new ProxyEndpoint({
destination: 'example.com',
pathPattern: '/*',
}),
})
const lambdaFunction = new EdgeAPILambda(stack, 'lambda', {
code: Code.fromAsset(path.resolve('../lambda/dist')),
codePath: path.resolve('../lambda/src/index.ts'), // gets added to the docs
handler: 'index.handler',
runtime: Runtime.NODEJS_18_X,
environment: {
aVariable: 'contents',
},
})
api.addEndpoint(
new LambdaEndpoint({
pathPattern: '/api/lambda',
lambdaFunction,
}),
)
api.addEndpoint(
new EdgeAPISwaggerEndpoint(stack, 'docs', {
api,
url: 'https://example.org',
pathPattern: '/swagger', // optional, defaults to /swagger
// optional
info: {
title: '', // defaults to Edge API
version: '', // defaults to 1.0.0
},
}),
)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for reapit-cdk.edge-api-swapper-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ad0bb2dfcb3ddf5fd682425f0a625f140d64e803b469a961ae9687730681730 |
|
MD5 | 77cbff8930fc459d3cb1aa0aed3e6257 |
|
BLAKE2b-256 | 07d1518dc1a4a00cdcba78206550881608038980afd2bb34bc86130690260af2 |
Close
Hashes for reapit_cdk.edge_api_swapper-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a5d8474ebee5fc29bc58bbfed3bd6ff162ad4a2fd81328b0e65b6c90c2f3a77 |
|
MD5 | ccd0d7b1b81e66bd5d5ba5d7fb6faa4e |
|
BLAKE2b-256 | 8661a63906acf003ba46211e4763677cd419613408e54630092aa513757f55fe |