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.665.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e0259ae47706ba48b461aa78ff4c729a37cf7936a104e189233a0ebc669e779 |
|
MD5 | 5ce1ca7fa6214ff2ffe3bb8f36425e36 |
|
BLAKE2b-256 | 08029ee82246387e969b688fb1317ec209b8ece021b6da390a9062e6fa85b3c0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.665-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 860b77ba6d7c69f1c8292d4affb99ab98ba02fb1b1c3db2a0d094a3e69363ca3 |
|
MD5 | 970bb064f9d2e1072cd7c67515da5053 |
|
BLAKE2b-256 | b2dd615df8322022a0c4f8ef1ec24c7eb331abdd5f3d58d96620e20b2bdd2799 |