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.230.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a7074aeaa6c19834993dcac002693cdccda17a47116b957b2bd2902c5786e96 |
|
MD5 | 7ffb92a19ec29d65f66526d4f983c454 |
|
BLAKE2b-256 | 2b590d24bf85a4d40bc5e24a49b663f2759a5ab9e4f5ecd7ccce67764b7874e7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.230-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1a718015de964ed7d1535bddbac33b8f1f28fff9d9c844975b9cc32f03d8771 |
|
MD5 | be7cda91ce913aa35495bb9386913a33 |
|
BLAKE2b-256 | 001f6ac387de46f53bbe146d439ed6a0c088126134df01188926a0f120409ac4 |