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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06ff8a7e71ff5924853c3cdf8c489ef4eaba5385ddc78fd926da3e9eb0310615 |
|
MD5 | fb4385e63de608e3ce996c0c3b15c505 |
|
BLAKE2b-256 | 9c04ee0dec838f5870e823a75b55ad89d189d4233724f6e5452a0639217181fc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1308f872f3e022da3a35d34ba4022888e50bea562a3afd63b555ee46e5c9bd1 |
|
MD5 | e9c0e92e07a21c31123af5ee644baf0c |
|
BLAKE2b-256 | ee41b72f9bbbdf26379924e79b536c0b2603c76eac207c2ef487db3b27ca1ceb |