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.616.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cbc85eb15123551700c031b8dd4da938d9874e48231f74de3d0888ff41fb17a |
|
MD5 | bd13062bfab1d58a164ecf976fd42927 |
|
BLAKE2b-256 | 887b804ae379f9c0bdcaf0df9088219c9321872ad34ca6831c310154d3d44ef2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.616-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b991e6b19633b328584cf46cf6e30ecf4f3a96dc2326d43f69ec016a6d9823f |
|
MD5 | 46178d5fc8f0a6cb4bb4da0262717d76 |
|
BLAKE2b-256 | 724ad7330c0fd41fb5d97053970adea8caae581fdcb847f7e5e55fc4fadac9b6 |