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.352.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb99a73fe1ceee343a9db270f2d49ff751ca9811b5f557ec2e764d47bf442451 |
|
MD5 | 25b59242eae390c0d417ed5c01b0cea0 |
|
BLAKE2b-256 | 56eb70350bb2344dc8b9623a302a58e85b076f822c358159a298319e14f8a6dc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.352-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2045e316137f584e6390684882bb7797300a7becd45b3d4f73e405fae144a8c4 |
|
MD5 | 127f3b4f3e250c67275d93caebbb6e3e |
|
BLAKE2b-256 | 8bb75c236b150e7c60f448bf881552a8b30d187137cc906ece4269b472079789 |