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.739.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85334daafeb031daeec5830893b28af25460ebdab60b0e2eaa522cb883590d28 |
|
MD5 | 488ba78a96049a8284a968863acba80c |
|
BLAKE2b-256 | bcf8944ee67f78ea118c1a8b88bbe789413f6c5ad37f810d9c3beedb649501cc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.739-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2034a21ce830d54d1a8123aa5e85d6fa4dcc0fc239477b9ea03a217366ee419 |
|
MD5 | d769f558b081517f6c7f2e939ed3a177 |
|
BLAKE2b-256 | 60733ff543f09785cf8c1dca482a7f0f665a0cd9bfa0bb00e1511577079a6518 |