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.754.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 926d50ee8c0af0aef32afd837a15c3a1b2b228421ae963010e7e40629b17f9fd |
|
MD5 | 0832ff9c13722b02dd0f86556dc1ac75 |
|
BLAKE2b-256 | bbbd9c9c79871e19996fac6598b276e605ba4e8fa77df77dac34162a08b8d0de |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.754-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce5d7ec0c9a8619f579dffeda8c6deef78269b009af84930c23b674262193d7a |
|
MD5 | c3f2f4a0e21babb9cf7d463ae26ebe99 |
|
BLAKE2b-256 | 99bf07d63e187b6a0f98bf7a9368c51f3683174363644062897c1ea34f3c3d48 |