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.73.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfe6cfe282db33cead0257c4731144aebab709a259ecdeaeb3a64ee4ba79bf97 |
|
MD5 | e205de5705e42e8dc73b63acbe5b270b |
|
BLAKE2b-256 | cf7f26e4ca76282c59f84a17b0d231403711015a86ad1a0750a5495c376fb60e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.73-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d47617c5a8733821f9ab5c21280667c87babe180b1c8bb0258842e88e795f1ac |
|
MD5 | 311c11506fd9bfa1f92d4a4354ec66ba |
|
BLAKE2b-256 | 532ed41ccc8c4e9d33824f83a603468456f19fbcdb3fe39c92cc8f8d6226fbc3 |