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.715.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f313d459dacd78dea751f5ad2772dda2fcba785740f30cb2d95da0ae98e35f66 |
|
MD5 | e2bdd53df74499023cb5ad9da51202e2 |
|
BLAKE2b-256 | 742706c73cb34468f0e31ecf183fb4a89bbb95469e6f5ead7273a3d355bbef67 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.715-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45c3307cd221cfc882fcb46bc8e552da262b47ec998faa15a52e9d460e109576 |
|
MD5 | 59c53b1a22deb10036106d659da1ec9a |
|
BLAKE2b-256 | 569cb9d1cda8a30fdb53b9c009799c28d97691cef13c98f854942c47dd278a15 |