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.760.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9533c8d15b0f4cd7afe64242a04d6a147e89aae6abdf9315d5dd339bcb6743c |
|
MD5 | f14ec2661a3e13921f0dbb9697670ad6 |
|
BLAKE2b-256 | 9c24cfdc9b63ad98d57fa6595c4df70125b95d2ff0a0a0ce3cdf347fae028fa0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.760-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 205f8ebaadf07767a889b78f8f1687fe5042867da7a6235d300ec57c10c2f50b |
|
MD5 | e796ca7dfc7c652ffa86634d05d32b29 |
|
BLAKE2b-256 | 34f12c2d38b727f69f57f3e3138a150a750f17a0335395aaccd642decfeb3570 |