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.186.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50e3a0cf60d53f7241c931407e7f14e988fd5df8d6babf97077bf42e941c14cc |
|
MD5 | f17f41d8a28621a05faed0322dba2533 |
|
BLAKE2b-256 | 9893e5b9a389d789e57124f47041b53e2c4a1d0148fbbf7faad6d7e75e1ed1c3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.186-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bfb7b4ada8a7e0e9de2bbc48a1626092a0f20ecd48ef676109752681bd641e3 |
|
MD5 | a7af8fa2ce89f008052815a3acaee532 |
|
BLAKE2b-256 | 690fe0e4d23e04115cef7f60b0b52c9ed55fc0b693d978e8494ea30b6fda8e09 |