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.598.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e1246cf942d095fa710da31737805d9a0e5c7979da51d0085e84db9e60d38f99 |
|
MD5 | 097329befee99414288a91a796ba3fb6 |
|
BLAKE2b-256 | 3e93276cafb149925fbb9600cf7ccae38d0ed5fac40417050d62b2f445b104aa |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.598-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c9fbedad5b953c22829e72e355a4d31f90d5fd6820e0afcb8327b6e456ea2b4 |
|
MD5 | dadf0f516c2a2867da57f8a05980bd7d |
|
BLAKE2b-256 | 5f115e8e633f99e3b871e0d39240c615480104b90d2deb32af887dbdb871c9ec |