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.684.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53f1974782d2c2fa583225eabd7ab845a066019e2abacd6dd508a26fd3bd99c9 |
|
MD5 | 8f04f4f1ed21064de6723164bafad4f3 |
|
BLAKE2b-256 | 1b455d03abc365561623e91cfd2b5505ef08d29859bcbd63f5be95d937feefab |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.684-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d8e4ec6d9645262036272bc42add64e9c8ee45cfc32b1ea9f6ba1d3ebf68720 |
|
MD5 | 603a45484b0d4ff5654f5625338bc19d |
|
BLAKE2b-256 | e45942386d23ffb66b292e00d459e25da33eb15409174e8a6df507e68322c2ff |