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.214.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd5bb3a6eb73ed2f16060703078708dd124d7ccc635bf58a41d1d9fdcf4310f5 |
|
MD5 | f986858afd3539d604326485aa141589 |
|
BLAKE2b-256 | 544be4d0a6397c830ef26fff642fa9413780a17826267e65200f7da2dcb332c6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.214-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ff092b7f3fe4b5ca701334483919d96b0f5910feca70eba0b97d35fae1ff933 |
|
MD5 | 71cd2c1f1920fc30b5ca37125c2980d2 |
|
BLAKE2b-256 | b2ceb3e77558149264cefc98aec4d7c9376482ca0a277a263f8bf85f75e882c4 |