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.462.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d147d28a18a6b88a38a98146a4381100e14f88f81200491bd215cd7a00d61821 |
|
MD5 | f40ebdbf34e48deb2e864d41d4a365a6 |
|
BLAKE2b-256 | 9170386d856b328eafc9d392351d5f27dde4003f00b5de6b9edc48edaeb7e817 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.462-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a00564d617c4794e1cd56d1cfa9be58a0411d7d36c1796849557086e74a64c09 |
|
MD5 | 3c7d882cae757a5c0fb3aabedfb6a88b |
|
BLAKE2b-256 | 2ca63194c851f3b2f9c94f79b89fd9753c6c4b9ae0e835823a59aa5615ad49f2 |