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.669.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | edd2dac5a69173db597642c1f90434259248c75cf50efd2755d0c882f2f5d336 |
|
MD5 | cc39d5adc76e80a943d84baf720301cf |
|
BLAKE2b-256 | 925ca28bfcd69fe41b884886767a55eba02bd2aebf33beee137e0cadfa96418c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.669-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 731a09310c9e1e13d2b809f01bebcde1e9742e7f8a214a54ee008f05367fc69c |
|
MD5 | 00cba0eb941dd1ae10ec5f7e27f8db53 |
|
BLAKE2b-256 | 0078e4d9648fdb718dd4888bba61e666518e109da6f2dcdec3118a8df227da3a |