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.404.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94db47353bccf1fbff93186db7e728eb40792a819ee5c7199eb81376ebaa56c1 |
|
MD5 | f7b855dbd58762a06e37cf6677dbe1da |
|
BLAKE2b-256 | bd3a26a364bd4b978aa6c41e2ee936a7b2d4a9944a536b137ca227a57babc628 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.404-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f2dbe89a9b520026b0d0d706dcc6f4f9c8daf173502343293f6797fbca9d419 |
|
MD5 | 89f510b24c3914a2d04e1e053c909d61 |
|
BLAKE2b-256 | 00b0b724dc6df28b6725bb9df85e59f78e02ec41015f62bf6c58986676f8b354 |