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.469.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 793213102e2ae2e30160fd55723d55531e81598a73094a91acc5e2acfcac3fc4 |
|
MD5 | 86acd7d1138f1e7542a7552851a40630 |
|
BLAKE2b-256 | e43fb53058c15147b65d443854d1498ec1b1f50d22248c4ba7f78ab402110005 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.469-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2061e9f115b44630b06ceb97164d137ab4d1731c993f1ffb4e7052d42b52f29b |
|
MD5 | ebb4cc5d5af88d714db41526ac407824 |
|
BLAKE2b-256 | 51e3c3a1f8a57c41c0cba36218b914630008639b5f284026605d1d3dac6704fe |