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.705.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13d79eaf1fb172c5829c0592b8ae0692ceead0dfd733f88ad6cb57dcb386e416 |
|
MD5 | dfb5649e1f73c9eafeecc5fab7ab84fe |
|
BLAKE2b-256 | c33ef401f51285b08aecbb7b3515ce417eb5eeba36399ada23e375f7ed97cb95 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.705-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ffb4e39f76b0bcc26e9a29b698a2b61eb54bf88c47afd0d5084718462afcac5 |
|
MD5 | e91890d9a4da3c56950a7ce0d89926b6 |
|
BLAKE2b-256 | 067a6e4f5b8c3f1081f20ac9e8ea6cef40f15f564f90d6dd83b948e634f4e0fa |