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.600.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eafadb29231adcec17f2f0a5b97ae6f8548efa122567358fdc7ea7e3632ee98e |
|
MD5 | dad48f2e45ac43dd9a466f05887109ce |
|
BLAKE2b-256 | 9afaa7e02b53d921d25bb1bfdba86c524cace84f47ebfb2726c29f941834a9f8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.600-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbee39f3783571169371714b590b974cb8bb94f43bdeb6e0b374fedef7fdf54e |
|
MD5 | 474fc0cc1125b330fca68ba40c7b87c9 |
|
BLAKE2b-256 | 34c8a5ca15bcc99c168505bc35774b1a803b4dd0e5691e9156a0751209dd3c53 |