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.51.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ccf090b53b2f795ff7d897f15d921008acc190ecd421c7d3989b602aa5727463 |
|
MD5 | bea12eacc5e92ba5ad94dfbcf8b2ab59 |
|
BLAKE2b-256 | dc6970b7b905e41140fae80bed3b2f9c187df6e030cbada3363bf2b763d16bb5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.51-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8936ee71d28f0ab578516b93680ef546416a0215b612935d78087012583bfa95 |
|
MD5 | 241107a1a5cc97c56d34b314160ff579 |
|
BLAKE2b-256 | 11f879b7e0e28dfda5eb16d09e30452e3a5f19f2269bf1aea47df7f4c4bc4df6 |