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.489.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc304ea021f78a91cd5d8fcd8359f876dbf0c068d4256c510ec5f2d4c6edc28f |
|
MD5 | 58f6ecb388728e3242bae6ab765d844b |
|
BLAKE2b-256 | 0d15bab9de7a5b3de4bb4a69c4873ecca943fed7ef22ae53411dfae39f4c82ce |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.489-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 265c33451f0dd06c68c937ef945e08ffd0adb592d88b8cc0a0a620bfeb11d35e |
|
MD5 | 5328cab22b1c6727312174647064c87d |
|
BLAKE2b-256 | 6a0122ba6c1ad570735aed46562ff03f71b45131b0d0681c2fe5387637cf2481 |