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.443.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5bc4352cd26e99aebbf4c1069eb792fa75ffa0300dcbb65c7380976d45322c2 |
|
MD5 | b5350a587a4053c4d7b5b54a241249e7 |
|
BLAKE2b-256 | 390f2b43de65ce182a12d1639776e2623a316ec27fae6a1872b125ca1fa8dca9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.443-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31bb04e533484d30f8819a3427315bef3c828ec4bacdea0c5cf49d773d611fc9 |
|
MD5 | f05498c2994413f236b7f8a1722c7513 |
|
BLAKE2b-256 | a30e7d294bf09215fbf1ad1b1ae185d5edb657e1f53f2ea69071eee38929677a |