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.281.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05fafd6753a94b03ea28cc20a2339899aaa4476fe15047d1ba790ea597055e79 |
|
MD5 | 846d32ec5be3327094da4174447fd085 |
|
BLAKE2b-256 | 9930f5e0265b658783ed1e02bc7d3efde13ab3037d58ebdb9a6044584bf9a8e5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.281-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a84e03eed971e2ca9fa35252a013de8ac256ad9c9c369096b546c741363a32a6 |
|
MD5 | aad2cd4012b77a4376bc7b3f58137581 |
|
BLAKE2b-256 | 7620d65d91dae4025df6864e334cb0b21d1c6587e9cd40ab86af05b8cb8e2200 |