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.851.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbd7eae700db59c648dafa3a7de6f22f5f9728a22f992fc9d1e67faf6e7d7a27 |
|
MD5 | fc7561cecba9deb1acc626678067c6fe |
|
BLAKE2b-256 | 4c827da3fb28e01b5996414b92a424bbaceef13bd8e5014599a1c9a0a566dbed |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.851-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bde19480a9b8fd29d4f4026e8f206de1b977e6ccf356af453d5f56089697f7b |
|
MD5 | 4b61aa1b6faa40e1d0a0ff6c93487478 |
|
BLAKE2b-256 | 9eeabd13a925b73437a2901463111a1d1a8a961f67a7d93eddf24855bf34a81c |