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.899.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22f32ae7a82adc33e3127e2869bb6807aece4c401ce6020b72ce36aa7303c5fb |
|
MD5 | ff7797d5129cd65bad24afbac5562d73 |
|
BLAKE2b-256 | 843bd5afbb72ee1f8c7220808fc2f8b9541eb3f33570dcd5ca2b9d72e824ed19 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.899-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e0e914a0e170c1efa9afc02bed53573e778d1afe44a62ef3fc1184861a13d9e |
|
MD5 | 2eb70d84b9ae513714ecfd2c9e42e9f5 |
|
BLAKE2b-256 | a698a59687d9ace0f468848cad23c5a1ea8022da1dcf6a2bb4874b73155c99f9 |