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.724.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65ee59d6315e3a370dd1910321dad938e34972d8e021877cb2364783efc08b1d |
|
MD5 | dd8ac8092ed181b6f438b971d48ec67d |
|
BLAKE2b-256 | 427352b7827081fed7e461b9888826d0ac3f66f2000f7ee6ad6362cb35b98862 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.724-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c60531a271ec0dee8d3322d2c08cae8a61eb8370d34ed2cf10997e1c9e67185b |
|
MD5 | 938ea8473ecc54ecb8d16cc9b42e893f |
|
BLAKE2b-256 | f7bbcb41a31dbb52a18bae353aedb6b04d43ae05854f5fd08e94b172b4ed6375 |