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.362.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07b49e3a9537f0055ec88bcd68c0c5ab8cab6031177ede563c26ca8d29ee214b |
|
MD5 | 211da29704f271b7243ca10b3d09dfe2 |
|
BLAKE2b-256 | dccd706192b97c9c7ffb5586971de01d9f6e3ce41ae6e53ebcc67d629aaba4cd |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.362-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57a861aa2dbf1c86b4e7af409853571c8f565617752e9df3489e1898bb289514 |
|
MD5 | 9f59c6247ac53c99862e165e2d0ca61c |
|
BLAKE2b-256 | 943a22bd9f9981cc4e58f7e46c794a6b53a21b06ebd267eabb1e3859da5b95c2 |