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.116.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5cb1551dc8ce1995044912be919242a6ba5ecc26dae6f5ba706de5cb5818f40 |
|
MD5 | 875fa12e6412fe4125369b30c1b7d480 |
|
BLAKE2b-256 | 61d935303a609a293ea2c74616e965068caf8afa05c7fd98da7325f8cfe3c6cf |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.116-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3c47ca6af82a42ebc370ac2f00704ca871b5646955ecb295b30de738008982a |
|
MD5 | cb0d788cab588c5634beea5636120143 |
|
BLAKE2b-256 | 09d8876f8afe975f1b05bfe4b2fae2420353b466d1b7bc3af23815858a76f6a8 |