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.502.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f6b324a57bb6842ff9e1ccc9041bebdb3778c4de2c6adf060fbc0f35745b85d |
|
MD5 | 3e1a506c66c3280c12be6c81822eef26 |
|
BLAKE2b-256 | e6108e8f4a09bf6a685ed1e9bca89bb6b2a0a57212fee76d887e8a3b991fd4f1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.502-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93cd88f2886df2f2e0f22c661bb834d09ced90dd4915d79b21a0b7000068ca47 |
|
MD5 | 32a1cf7b2d511bf71aaac72cba41aba2 |
|
BLAKE2b-256 | 7831a3caae1406ffc2e8c6ccf9cba1f811f73bb367a68f7792a42155ad45d3d9 |