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.60.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7488bdd55b0af5b50558e1d83eeda65c9178fc25b5fce5f03bee5ecfa5df1f54 |
|
MD5 | 85301c3bfb89f319ac014263d09a9b37 |
|
BLAKE2b-256 | ccf66e350cd924b06624399992753475102f0b3072b095c3dc0fe0d6e8ebc794 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.60-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 903ba1b34a8fe99abb63db9463a85d4ae16f2f0ab8bfe45553d0215359db5889 |
|
MD5 | f7d4fb84e4ade8888ecf666ff6e76dd8 |
|
BLAKE2b-256 | 87cdd3bafa8cfe6b20500711bb1a90938aaeb9bc70ff7af78e53eed4fbd1654e |