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.461.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 818a11f0a0606fb315f664ace2b43842e571984e7cb96455a74e38fd14a39c98 |
|
MD5 | 29e9dca6037c5c46e701642c26b32e11 |
|
BLAKE2b-256 | 66dcdb6c1677633546e42690dc8826790ab73269038fd6af7fde5be0111ba327 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.461-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d92e2503d42436ceeb64416dca7da5eaa13349d6f2a243ba0f846b124572938 |
|
MD5 | 6a3a80353bd4b7e5eedd015563ef002e |
|
BLAKE2b-256 | e52eff73512b868f6d918df27cb8c6c582f87faa5f420f9a959d395f67847db1 |