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.396.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0b1c72fae854ed0ed2ae3eddfbf026a46bb123ded87266b331664fe20d46953 |
|
MD5 | 69315bb8760fdd217f09d650c37fb7ff |
|
BLAKE2b-256 | 18b32d57d945a8bf6088b9dce06f92c6f97b78338e8b5eca62f62c926a4fa4ad |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.396-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 076aaaf72ae0b0bbc3548c0357cdf693603f00bf1174367f76b14346c50fb7c6 |
|
MD5 | 40c991ede8181d0bc3b01fe6eb22c7fb |
|
BLAKE2b-256 | bc4ee17e4b46c13332eb2cc1b7498ecd0d26c8c639093f6088d430552a4605b4 |