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.869.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ebb8289ad49dee62278958ef51bba35459e1ffd5454d6dd0377eb90c5cd2b83 |
|
MD5 | ce98160ab5965b68a51efa53e23a1fa4 |
|
BLAKE2b-256 | e60cfd8e5863203e3d970c8bd5ecd6099fd0bc522a261d1f5a97da69acc56a98 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.869-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b25d2da430458ad89fd2e2bf508a480cf46d7cf60d98a1f1cf552dc57860f192 |
|
MD5 | 38aa5c9c9d13d57122d65f65b4e9c071 |
|
BLAKE2b-256 | e8926369e556ccddb22f06c72e59294343bd115697d990450dc84d63f771e636 |