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.722.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15531f3c933078d9efed69024d1b9be99e4c16120c0ffe9ce092729ff0e53ec6 |
|
MD5 | 16527272bffb4d2713c509bd29ada6bc |
|
BLAKE2b-256 | 10be73fddb57dfca06bb6001faf85c01768d59ce73bbbbe5505ae06618ee682d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.722-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ac69448f3625a608316623a765aecd37a8d52815e43f68b93665ae54df49647 |
|
MD5 | 5de60a7eccdbc2dea8e25ce19fd4ac92 |
|
BLAKE2b-256 | 88cbe9460d7055e5d2355157319266ca96983570330bb1c0974f38c3439b346e |