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.146.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba4641660d905c4ecfd8909b2e78dade1e167f844a17be45f217ab5082a8b6c5 |
|
MD5 | 784ba0e7d12e1ceb0028479f4fb7b0e5 |
|
BLAKE2b-256 | 338f1eb7b10029ca5a3971c8569a81b07836e8b7f0ecccc619e89e17d93fc54b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.146-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 869f67c0f5786fa90f00c9a861b5d703c2514148adff8416ca58e7427c419b2c |
|
MD5 | af97e9ad3a0fbb12952190fcceca7688 |
|
BLAKE2b-256 | 8e48b3ed9265d41527d02d3ef3f24eda59fe4d7ee4add170af93b13f44ab3fab |