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.135.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1974954f47b2fe8eb2b4323dcee682bf57442ccd6e9425738d97672891a8ba4a |
|
MD5 | bf5be404e1b30715ecb18727769712e0 |
|
BLAKE2b-256 | 6fe83bee748a4ba0db71e4934d03ef79ae9d51730bdaccc31c0695dc6ebf3328 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.135-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b66bc88dad59e71a23974757150922d59e4cf68cae2274d23bc396a202f10426 |
|
MD5 | 8ab508d5cd87e29a08c36820f4c246fb |
|
BLAKE2b-256 | 9f2fa59b534089e35d6c501ddbb391a4f0fd80044ac376fdc14891240ac2fb28 |