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.428.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9257be18792e1201cd5a7815999ad5f84963ba311bbb8b152adf5ecbf5161610 |
|
MD5 | 44fa24d812c3aeec472664109cb5e730 |
|
BLAKE2b-256 | 46e1714026b79208a86d82c6b3cdc01ce25e31a23b4a3fbdf031d1319401206d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.428-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 917b95d55086140b69de275afd4e13cd3a0c5bfc5dd75c27aa4f281c9e5c33e3 |
|
MD5 | 1ac7d7b5b4919d75fb15f978e2cb02af |
|
BLAKE2b-256 | a81e7d4027033ad03cf73eefc522998197aca95cc42e6261516b1f08cf6fa5f3 |