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.106.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18cb6f272ca41a2f2e5503d9e3324ed46f65a4b5a3c549e0065bcca883a1dbc6 |
|
MD5 | 63f93e5ddaca4e992e42246c42b52c65 |
|
BLAKE2b-256 | 682ed834262ce13b26a796ae017dc3321eba63ce2f665b6fcdc537ad920059f2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.106-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 962e6e3df373f16b12fd49bca08f386c632758929fb55235eb423d30bd2adb9c |
|
MD5 | 03b60f45f215a26d1c4f2e736b36b043 |
|
BLAKE2b-256 | 3b751b48e947ab1b0e8f0eb7bc6161a426d95dafc6c670500ee69ca9bbb2b99c |