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.586.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 903835cf78612937bbffcad00a0d00455f9a745c8597124e89365ed5b8a8c32f |
|
MD5 | 1ac8102a5c013958d65ae2a560ebe933 |
|
BLAKE2b-256 | 0e6fdac9f45d7c228981c89f90073794481c3f30ebf11327121f6046d0006d89 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.586-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c2e3ab12442919a26de6be3794cd524a45c09159c72c4694308d59c022afdfe |
|
MD5 | e6c1a7a9a3fdf76e1647c58b698d7042 |
|
BLAKE2b-256 | a726afb5444c8bca93459b3f4f8061f590e48612f6b748fde1b0192589e0059b |