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.741.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4cc9dfc1805aaac37fc58f6e7000293e01437fa36987287efda528830dc3a166 |
|
MD5 | 32a7387290ef746b9d3f3c5b0d529896 |
|
BLAKE2b-256 | 65732392260e26c676487d9dd2840d01c69a30bc97e0a04353b299909fa1f85c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.741-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c9202ea9c066578252dafd4231780b6435f8a4fa37cba4962a74cf528ad1f54 |
|
MD5 | 33224557ec165ccee0dd69aea8ddf0fb |
|
BLAKE2b-256 | 65f88897c6df4d14bf1857646db8cfb82c33d3b94612052f5295133b187f3130 |