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.594.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4371b7096601e7bc6169554d7437e3ce70a461b2623e77895192a3d3dc26707d |
|
MD5 | fbf81e40ad08f6a7413491af4ad191e9 |
|
BLAKE2b-256 | 93ec0f405767f95960fce62ef25e5aa13b9a68e3d5337482a0e30150e7177bed |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.594-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ceaf3195bfd0dd45cdaf9837f5869c9cc8d7c74bfd4f6edd0dda09d1faa76a77 |
|
MD5 | 6192a8cb29e2e8833e83074dd22d8554 |
|
BLAKE2b-256 | 5765894eef1bedc6736a6ef913b0b882967ea8769c2ce68609caa7745f65431b |