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.775.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b9e1ba6e13b8c8395669fdc77f8a6ff5117d827c57a16aed3120a06cdcf1238 |
|
MD5 | be653c5ca5b8564a186c5c46cbefc507 |
|
BLAKE2b-256 | bf065570465e142f5e0478882e2fb1e0e212f4c5b36b7889051ae3533883b7ab |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.775-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 564f14a257b71b0d6d6629df6726a1e9b6c088e039098d7495a292b3982b9c4a |
|
MD5 | 615c95cd93569298946ba4a57ec37a4c |
|
BLAKE2b-256 | a7ee87361e2ce33ef16ed28e0a49372978d8c80d7a0c2e62c3e047c37f3f4b04 |