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.359.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 864ed23269f471a198ca9d522dae8807ae142407f415cc5b345b272ef3a480c0 |
|
MD5 | 8ba4dd8bdb7d6ed7af648d7ada9aeefa |
|
BLAKE2b-256 | 1faba1f8c4ce6235e234ea962b91e394102c377a160acb3a398036e140631178 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.359-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0bf2c13637d6c7084b418118de8436b8fb5a9c7c60c10015c48af4940d7fa436 |
|
MD5 | 9230c6f80d18bd77d5415c579bdff136 |
|
BLAKE2b-256 | 3c5fa0ef11627ea48bab4566e94fc4aeb420bf4943e4ac0054bc75256c958ead |