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.185.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f4845824fb7ff265346ae89c35d5d185e78eb75cda39757ff04d5982feaa037 |
|
MD5 | dbab501da93b07cf088fe7b4d668ee6c |
|
BLAKE2b-256 | 7ead1ff26db8c08085ba3eba16868127cdd27b2aeecb8c893c94d41d3bfddb7d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.185-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88e36227737d634452a54f54530cd45c746da0678f9ec59b63f0ef808cbc2c72 |
|
MD5 | a4c2b31b803a5fa43727799b7d7b98f9 |
|
BLAKE2b-256 | bd1d7f14c62dee746b53e2371328212d1d2a6773133c51f58fdec2d5e1e6a78d |