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.712.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | af5e3e230b136c8645eec837358a481582297bf536cecb9e80c333b7a7cb6525 |
|
MD5 | fb459f8adbd42d12ab283841d72e9857 |
|
BLAKE2b-256 | 8a7de2c34177e6df44ecdea2cbefd13331c70fdafea08603e783308339d6a0d7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.712-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f459355107d68c430789fed181faa67dc6f02e334c0b109da65183a959271ba1 |
|
MD5 | 8d7cb17d4c8cb19ae57e7151b43ec756 |
|
BLAKE2b-256 | 4ac6ba3bc9e7fceb31572c6a1e21dcff305b603f4654f2909271ef931fa7fbca |