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.39.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d97f05aec4c806cd692dd8b611c9feb5acbb2b8aa3016315c75b971c9f1f1252 |
|
MD5 | ff3a9e17e4e3316ecd3fedd8ae8e84a5 |
|
BLAKE2b-256 | 4b926486de936fe61b4913e086e424554e96808f9f303f18540de3b1cf74cbc5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.39-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65166012ce0d718dbd1380968c605fa813467a3b211cf623ed2e5e7d776695d1 |
|
MD5 | 978e6380046d855df487fe9a8465bcd3 |
|
BLAKE2b-256 | de1630ec44afa51fb949a6141fc80af13e217f5a1c42f65ba3a109dbf9c931ff |