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.788.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 511aa95a8a1209f80b39d89c2ba5b8299132ac47ef0ba220b7067997c5315a2e |
|
MD5 | 6df278d2a1d7cd11e5962c94c9133019 |
|
BLAKE2b-256 | d09914752125677437ad7556ec50be672f4ea178fc3bc76799c548a82549f51c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.788-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 453559e398dce4ad83b025827d82c3f4ec7ba0defd1b46b769c23160ad582e4b |
|
MD5 | 22931e74cbdd6b37a6ce8b52fd8bb65d |
|
BLAKE2b-256 | 2bf56bc684c8f54e34f54d2998735210d698a258a93e262dac3c44c1054b33f1 |