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.418.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 287b83b4496e76cf8c4e29a41164b24ceaceffe64ddcf55fd28e8ee6d5480d37 |
|
MD5 | fe8eb932743f6dd275f91e2b30b1cb6e |
|
BLAKE2b-256 | 70159d20f426119f9edd5e6891452217431e763dbd4597eca057a987ac38fd9b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.418-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6012b403cd6d75e9f172ce471fa16f4ba6633eecabea11ccadb889a519ba97b |
|
MD5 | 4b36aaf88bd3763ef1fd97f61e95ed62 |
|
BLAKE2b-256 | aa996cdab54bbe2ee77d92b1e87c9cd5cbff64151aaf4f691a6fa0c4a3961efe |