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.485.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95feeb80a4c5ba78b8defbd3fa626c546acb78c9c407ecad4c782d2077bdcac6 |
|
MD5 | c89eb10ce3c3a5ef9173cd287f4e0f7c |
|
BLAKE2b-256 | 0664444def890b2e0c034026292fca7991f4fb71cd8bb0c9e66605d1472568f4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.485-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a463f62e4328119c518d1a909aec30ff6fe6926056567227c11e238717826393 |
|
MD5 | 9cb03478c67767b20702ae22336d0fa8 |
|
BLAKE2b-256 | c6c43ee4300edfd6b40b84e3e5b7121e1acb92853713efddda8dbf764501a664 |