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.826.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7100a33d91f722e9b714f3ad765ce3d6b7b6c7f8402283d8bdf8003386a3a27c |
|
MD5 | 4c806893f70b339bbd6a497c26155cd7 |
|
BLAKE2b-256 | 424f36627daf37405045240763f242715e7850127c170c061dfc52a1562e3a9c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.826-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3cfcb4dd7424df3fcf17762a509c9193f8265f92470db670e7ae689aae21a1ee |
|
MD5 | 50fe06ec1607c1884211ac2d8dd381e1 |
|
BLAKE2b-256 | eef2281e5bfa01a800cbe436c455875ab6a0b43a47676d58d53882dd59b50330 |