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.247.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca46178bb8401c17dbe608eb4479761a09f6c7b2c491175c0b78e902f3830e16 |
|
MD5 | 01c95ed3e714190e9709d18053e26ddc |
|
BLAKE2b-256 | 281c4fbee6f7aefcda10be723a682577652c5e4fffb97547fcc70d9d197db88a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.247-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b470f120102affbc6bdec396b6b4f9fd97f2482397b671923ee4f1e69a204fe |
|
MD5 | 42393e81f1f14f9410ebf07c11901e10 |
|
BLAKE2b-256 | 711f8af57cea31eb287310e4cfd6f4cf399d4599b16f4fde849467b361557dc1 |