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.400.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6b3e92b0eb23b7a83773af118303f322fbd4dbcefa63842c30e4ff09eb11b2d |
|
MD5 | 4a12211ef215437160f9100599917155 |
|
BLAKE2b-256 | 6c27db2591b84bccc601982f3ef8e19a42de9e8eb9806af7b2e527a15c2f3f65 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.400-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | beec26a24e030ad67c9b17b2040e582e0d00bd6ce4c8095b3cea3c552dfbacc3 |
|
MD5 | 03a27e29e911fb3aea6fb4bd1181cf16 |
|
BLAKE2b-256 | 39ad0333651f68314e34321bf453051398824cbda548dca1c36ad747c91488d9 |