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.46.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4fcebccf51f3c8bf2e85107c696f4eb21a8d083f4a852734487003f9880b2612 |
|
MD5 | 011ba091b60015c17c8aa178cb4e47c7 |
|
BLAKE2b-256 | 51cd4706b67b36c13ab91ed88e8c33f38b3a862f04c03366b3650d3939ea9665 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.46-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c87699b5678a7f12c81707ca5ba3a4ddda8fcea5fad22ffc09fa9201afb4a48 |
|
MD5 | c3f334e5b421077d725aac1fc76bb3ff |
|
BLAKE2b-256 | ef2e5a245f6d707e039652f6361219ae496784ec9922b137a9950364d578c7e9 |