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.105.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d626c77394e08b93de3dbdc10537fe32dadf10da39b387833d193e2985844e44 |
|
MD5 | 2f778817712141bbfae9439509560238 |
|
BLAKE2b-256 | e24adaf07b08782c6252646381fd6dfac5d61708a4aeb23b6d785fbe92d9a6e5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.105-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 688bba81f51ae1ed0c201cda1f89c02091ab838449dfa322e1c110584f8deee3 |
|
MD5 | bae9893a158ffad3acb229c520e7b116 |
|
BLAKE2b-256 | 616135ccb4d2a2f58574847a70aa9b06a6bff892326c65b72319b59553245ac4 |