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.555.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe31c0acded8bafaf98e1d95087aea587abba99a9f2baf3b43686c1ca8d96c86 |
|
MD5 | 8a42e2f6ef5e177b04442c250e5959c5 |
|
BLAKE2b-256 | 09182c94f325016f64948df39a47ba6e5fb1a14b7f65172fe244903845c5fffd |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.555-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3ceb27c9e99ce7d9cffbe59b359e6ddcb96a4e624c432bbffd56481f57cbcb8 |
|
MD5 | a7a0cb973e42106fcd417966bbf559e0 |
|
BLAKE2b-256 | 2283dcd9f25c04073604c249356e05639bf30f9240335f868bf34075730c863a |