Add SwaggerUI to your AWS Apigateway RestApi
Project description
CDK Apigateway SwaggerUI
Add SwaggerUI to your AWS Apigateway RestApi
Install
TypeScript
npm install @pepperize/cdk-apigateway-swagger-ui
or
yarn add @pepperize/cdk-apigateway-swagger-ui
Python
pip install pepperize.cdk-apigateway-swagger-ui
C# / .Net
dotnet add package Pepperize.CDK.ApigatewaySwaggerUi
Java
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-apigateway-swagger-ui</artifactId>
<version>${cdkApigatewaySwaggerUi.version}</version>
</dependency>
Usage
import { Stack } from "aws-cdk-lib";
import * as apigateway from "aws-cdk-lib/aws-apigateway";
import { SwaggerUi } from "@pepperize/cdk-apigateway-swagger-ui";
const stack = new Stack();
const restApi = new apigateway.RestApi();
new SwaggerUi(stack, "SwaggerUI", { resource: restApi.root });
- Open your SwaggerUI:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs/swagger-ui.html
- View your API docs:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs.json
Project details
Release history Release notifications | RSS feed
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 pepperize.cdk-apigateway-swagger-ui-0.0.534.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5ead4be5fdb1ff770505b382981ee47d93096bd5a91858c82c3fdd61c6ce6d6 |
|
MD5 | 6a14d362126580507d6bdf4f53777c63 |
|
BLAKE2b-256 | ded8c6885c69fdae602db42ff8ffbc0975bf02f698955fdbdded663ff84e732e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.534-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99df61aa1899c74566418170f046972986c999827d7d2053a2a3e59f8af022cc |
|
MD5 | 803dc1245b3862d6a91d0eb9afd7b3bf |
|
BLAKE2b-256 | 00a7751b7d0130885a75ffe84ce5a9a83d1269ef841dc58c8bf169238b7a8e08 |