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.747.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b062960497e136d37672f611e6b027f706db235e66ff5f77208c5c979f4d724 |
|
MD5 | 1a92b7f37646ad40bddcbad684d58926 |
|
BLAKE2b-256 | fa929e4fe0367934ba8aa82c8852b7bf121ad21c08d74c5f966a40746332f560 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.747-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6da34621aebd2c61d8066998bc0f089b70ac25c4201d5486cce884ff630894a0 |
|
MD5 | 2594ebdfc47111ef8fd6baa63292ca67 |
|
BLAKE2b-256 | 58bec218205b10fc6cb6654c20c08680a1c9481353aaa97490ddec89cee9a293 |