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.501.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 357ff7656b14fe6f6cfff6821f1ba11b20a0194b5304020a07d6b41188d101ed |
|
MD5 | 44150edea4dc5cf0b091c6865c33233b |
|
BLAKE2b-256 | 0e235ebcdb3af4c6c149af2e063ad4fa2cf5423a8d9ef808f8b70c3130175da1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.501-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a26201d0798152ff729cfdba29380681b3ea3cf1f9a8010209cddb25bb0cbd62 |
|
MD5 | 6ab92065c6957328257a6013c6a50511 |
|
BLAKE2b-256 | 212d1d3a79f4edccd6494e5e62e571318a131a7718d3d76a74bcaf8d9ca06d44 |