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.789.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8119094f704f6c384c4d0666213a6bb0c04785555d5e83998e80be67e78b56f7 |
|
MD5 | 81eed187e3a75ca331a2ec965bc22cb5 |
|
BLAKE2b-256 | aaa904b47b210ec480dcb9063e06eb8d219e61edcc90d3e6ea02092b3228a487 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.789-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32941e96465d4ba14f9114ffc9511c7a4b24134ea8dba077a6d28f2fb3da733c |
|
MD5 | daa4e4da0165f2eb899bc135bb8b70f4 |
|
BLAKE2b-256 | 9eb44173c61c0a4e6adc95b045a496b95530235906d6dc2b4417f550844771da |